Skip to main content
POST
/
webhooks
Add new webhook instance
curl --request POST \
  --url https://api.chift.eu/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "event": "<string>",
  "url": "<string>",
  "signingsecret": "<string>",
  "integrationid": 123
}
'
{
  "webhookid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "accountid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdon": "2023-11-07T05:31:56Z",
  "event": "<string>",
  "url": "<string>",
  "status": "active",
  "createdby": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "integrationid": 123
}

Authorizations

​
Authorization
string
header
required

This access token needs to be included in each of your request to the Chift API.

Body

application/json
​
event
string
required
Maximum string length: 80
​
url
string
required
Maximum string length: 500
​
signingsecret
string | null
Maximum string length: 100
​
integrationid
integer | null

Can be used to specify the integration code of a specific connector. This is mandatory in case you create a webhook related to a specific One API.

Response

Successful Response

​
webhookid
string<uuid>
required
​
accountid
string<uuid>
required
​
createdon
string<date-time>
required
​
event
string
required
​
url
string
required
​
status
enum<string>
required
Available options:
active,
inactive
​
createdby
string<uuid> | null
​
integrationid
integer | null