Create Webhook Public

curl --request POST \
  --url https://api.example.com/webhooks \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "events": [
    "proposal.created",
    "proposal.status_changed"
  ],
  "name": "My n8n Automation",
  "url": "https://my-n8n.example.com/webhook/quikly"
}
'

import requests

url = "https://api.example.com/webhooks"

payload = {
    "events": ["proposal.created", "proposal.status_changed"],
    "name": "My n8n Automation",
    "url": "https://my-n8n.example.com/webhook/quikly"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    events: ['proposal.created', 'proposal.status_changed'],
    name: 'My n8n Automation',
    url: 'https://my-n8n.example.com/webhook/quikly'
  })
};

fetch('https://api.example.com/webhooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/webhooks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'events' => [
        'proposal.created',
        'proposal.status_changed'
    ],
    'name' => 'My n8n Automation',
    'url' => 'https://my-n8n.example.com/webhook/quikly'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/webhooks"

	payload := strings.NewReader("{\n  \"events\": [\n    \"proposal.created\",\n    \"proposal.status_changed\"\n  ],\n  \"name\": \"My n8n Automation\",\n  \"url\": \"https://my-n8n.example.com/webhook/quikly\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/webhooks")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"events\": [\n    \"proposal.created\",\n    \"proposal.status_changed\"\n  ],\n  \"name\": \"My n8n Automation\",\n  \"url\": \"https://my-n8n.example.com/webhook/quikly\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/webhooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"events\": [\n    \"proposal.created\",\n    \"proposal.status_changed\"\n  ],\n  \"name\": \"My n8n Automation\",\n  \"url\": \"https://my-n8n.example.com/webhook/quikly\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "url": "<string>",
  "secret": "<string>",
  "events": [
    "<string>"
  ],
  "isActive": true,
  "createdAt": "2023-11-07T05:31:56Z"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Webhooks

Create Webhook Public

Create a new webhook.

Required scope: write

Important: The webhook secret is only returned once on creation. Store it securely to verify webhook signatures.

Signature verification (Python example):

import hmac
import hashlib

def verify_signature(payload: str, secret: str, signature: str) -> bool:
    expected = hmac.new(
        secret.encode(),
        payload.encode(),
        hashlib.sha256
    ).hexdigest()
    return hmac.compare_digest(expected, signature)

Headers sent with webhooks:

X-Quikly-Event: Event type (e.g., “proposal.created”)
X-Quikly-Signature: HMAC-SHA256 signature of the payload
X-Quikly-Timestamp: Unix timestamp
X-Quikly-Webhook-Id: ID of the webhook configuration

POST

webhooks

Create Webhook Public

curl --request POST \
  --url https://api.example.com/webhooks \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "events": [
    "proposal.created",
    "proposal.status_changed"
  ],
  "name": "My n8n Automation",
  "url": "https://my-n8n.example.com/webhook/quikly"
}
'

import requests

url = "https://api.example.com/webhooks"

payload = {
    "events": ["proposal.created", "proposal.status_changed"],
    "name": "My n8n Automation",
    "url": "https://my-n8n.example.com/webhook/quikly"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    events: ['proposal.created', 'proposal.status_changed'],
    name: 'My n8n Automation',
    url: 'https://my-n8n.example.com/webhook/quikly'
  })
};

fetch('https://api.example.com/webhooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/webhooks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'events' => [
        'proposal.created',
        'proposal.status_changed'
    ],
    'name' => 'My n8n Automation',
    'url' => 'https://my-n8n.example.com/webhook/quikly'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/webhooks"

	payload := strings.NewReader("{\n  \"events\": [\n    \"proposal.created\",\n    \"proposal.status_changed\"\n  ],\n  \"name\": \"My n8n Automation\",\n  \"url\": \"https://my-n8n.example.com/webhook/quikly\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/webhooks")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"events\": [\n    \"proposal.created\",\n    \"proposal.status_changed\"\n  ],\n  \"name\": \"My n8n Automation\",\n  \"url\": \"https://my-n8n.example.com/webhook/quikly\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/webhooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"events\": [\n    \"proposal.created\",\n    \"proposal.status_changed\"\n  ],\n  \"name\": \"My n8n Automation\",\n  \"url\": \"https://my-n8n.example.com/webhook/quikly\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "url": "<string>",
  "secret": "<string>",
  "events": [
    "<string>"
  ],
  "isActive": true,
  "createdAt": "2023-11-07T05:31:56Z"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Body

application/json

Schema for creating a new webhook.

name

string

required

Webhook name

Required string length: 1 - 255

url

string<uri>

required

URL to receive webhook notifications

Required string length: 1 - 2083

events

string[]

required

Events to subscribe to

Minimum array length: 1

Response

Successful Response

Schema for webhook response including secret (only on create).

string<uuid>

required

name

string

required

url

string

required

secret

string

required

events

string[]

required

isActive

boolean

required

createdAt

string<date-time>

required