v47

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-013871777.1 KB

Webhook-Subscription

Create a webhook subscription

Creates a webhook subscription that sends various events from Ivy to a specified url. There can be multiple subscriptions per app.

post/api/service/webhook-subscription/create

Headers

Idempotency-Keystring

Idempotency key for safe retries. Reusing a key with an identical request body returns the cached response. Reusing a key with a different body returns 409.

Request body

urlstring required

The endpoint where webhook events are sent.

eventsstring[]

The events to subscribe the url to.

Response

Returns the new webhook subscription.

{"stackTrail":"components:schemas:CreateResponseDto:properties:id","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:CreateResponseDto:properties:merchant","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:CreateResponseDto:properties:merchantApp","oasType":"schema","type":"unknown"}

urlstring required

eventsstring[] required

{"stackTrail":"components:schemas:CreateResponseDto:properties:createdAt","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:CreateResponseDto:properties:updatedAt","oasType":"schema","type":"unknown"}