Webhooks
Register webhook to receive dispatch events
Register a webhook to receive and acknowledge dispatch events,
to be signed with your secret.
POST
/
entities
/
webhooks
/
dispatch
/
url
Authorization
Body
curl --request POST \
--url http://localhost:8001/entities/webhooks/dispatch/url \
--header 'Content-Type: application/json' \
--data '{
"secret": "<string>",
"url": "<string>"
}'
"<any>"
For an example response signed with the X-Axle-Signature
header, see
the example dispatch event endpoint.
Body
application/json
secret
string
requiredA secret which will be used to sign events sent via the firehose. We sign events with the header X-Axle-Signature, which is a SHA256 HMAC of the event ID, using this secret as the key.
url
string
requiredResponse
200 - application/json
The response is of type any
.
curl --request POST \
--url http://localhost:8001/entities/webhooks/dispatch/url \
--header 'Content-Type: application/json' \
--data '{
"secret": "<string>",
"url": "<string>"
}'
"<any>"