Webhooks

Create Webhook

POST

This endpoint creates a V3 webhook subscription of the type provided in the type attribute of the Webhook object.

Note: This endpoint will create a V3 webhook — you cannot view V3 webhooks from the V1 or V2 endpoints.


For more information see the Webhook Model.

Request

This endpoint expects an object.
type
stringRequired
The event type for the webhook.
url
stringRequired
The URL where events for this webhook will be sent.
id
integerOptional
Unique identifier for the webhook managed by Impilo.

Response

This endpoint returns an object
type
string
The event type for the webhook.
url
string
The URL where events for this webhook will be sent.
id
integerOptional
Unique identifier for the webhook managed by Impilo.
POST
1curl -X POST https://app.impiloplatform.com/api/v3/webhook \
2 -H "Impilo-API-Key: <apiKey>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "type": "order.status",
6 "url": "https://impilo.health"
7}'
200Successful
1{
2 "type": "order.status",
3 "url": "https://impilo.health",
4 "id": 123
5}