Skip to main content
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"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "url": "<string>",
  "secret": "<string>",
  "events": [
    "<string>"
  ],
  "isActive": true,
  "createdAt": "2023-11-07T05:31:56Z"
}

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).

id
string<uuid>
required
name
string
required
url
string
required
secret
string
required
events
string[]
required
isActive
boolean
required
createdAt
string<date-time>
required