Webhooks

Patch Webhook

PATCH

This endpoint updates the specified Webhook with a new URL provided in the request body.

Note: The provided URL must be different than the existing URL of the webhook or a 400 response will be returned.


For more information see the Webhook Model.

Path parameters

webhookIdintegerRequired

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.
PATCH
1curl -X PATCH https://app.impiloplatform.com/api/v3/webhook/1 \
2 -H "Impilo-API-Key: <apiKey>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "type": "eventType",
6 "url": "https://impilo.health/new-url"
7}'
200Updated
1{
2 "type": "order.status",
3 "url": "https://impilo.health/new-url",
4 "id": 123
5}