Webhooks

Create a webhook

POST
Create a webhook

Request

This endpoint expects an object.
url
stringRequired
The url to send the webhook to
triggers
list of enumsRequired
The events that will trigger the webhook
active
booleanRequired
Whether the webhook is active
headers
list of objectsOptional
Optional headers to send with the webhook
secret
stringOptional
The secret to use to sign the webhook payload. If you do not provide a secret, one will be generated for you.
model
enumOptional

The model for the webhook trigger to monitor. Only applies to DATA_UPDATE and DATA_NEW triggers

Response

This endpoint returns an object
result
object
POST
1curl -X POST https://api.propexo.com/v1/webhooks \
2 -H "Authorization: Bearer <token>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "url": "url",
6 "triggers": [
7 "DATA_UPDATE"
8 ],
9 "active": true
10}'
200Successful
1{
2 "result": {
3 "id": "clwktsp9v000008l31iv218hn",
4 "created_at": "2024-03-21T15:38:08.337Z",
5 "updated_at": "2024-03-22T10:59:45.119Z",
6 "url": "url",
7 "active": true,
8 "secret": "secret",
9 "system": "PRODUCTION",
10 "headers": [
11 {
12 "header": "header",
13 "value": "value"
14 }
15 ],
16 "triggers": [
17 {
18 "id": "id",
19 "trigger": "trigger"
20 }
21 ]
22 }
23}