Webhooks

Create a webhook

POST
https://api.propexo.com/v1/webhooks
Create a webhook

Request

This endpoint expects an object.
url
string
The url to send the webhook to
triggers
list of enums
The events that will trigger the webhook
active
boolean
Whether the webhook is active
headers
optional list of objects
Optional headers to send with the webhook
secret
optional string
The secret to use to sign the webhook payload. If you do not provide a secret, one will be generated for you.
model
optional enum
The model for the webhook trigger to monitor. Only applies to DATA_UPDATE and DATA_NEW triggers

Response

This endpoint return an object.
result
object
POST
/v1/webhooks
curl -X POST https://api.propexo.com/v1/webhooks \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"url": "url",
"triggers": [
"DATA_UPDATE"
],
"active": true
}'
Response
{
"result": {
"id": "id",
"created_at": "created_at",
"updated_at": "updated_at",
"url": "url",
"active": true,
"secret": "secret",
"system": "PRODUCTION",
"headers": [
{
"header": "header",
"value": "value"
}
],
"triggers": [
{
"id": "id",
"trigger": "trigger"
}
]
}
}