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"}

Changes

Changed in 6 of the 52 revisions of this API.6313

Aug 25, 2026a2c2fbc14f4b12See the full diff
- ▲
  removed the enum value data_session_completed of the request property /
  request-property-enum-value-removed
- ○
  the request property default value changed from test merchant_updated merchant_app_updated order_created order_updated refund_succeeded refund_failed refund.initiated refund.succeeded refund.failed payout_report_requested data_session_completed checkout_session_created checkout_session_updated checkout_session_expired checkout_session_completed payout_created payout_updated user_payout.initiated user_payout.failed user_payout.paid payout.initiated payout.failed payout.paid deposit.received return.initiated return.succeeded return.failed return.returned fx.initiated fx.succeeded fx.failed to test merchant_updated merchant_app_updated order_created order_updated refund_succeeded refund_failed refund.initiated refund.succeeded refund.failed payout_report_requested checkout_session_created checkout_session_updated checkout_session_expired checkout_session_completed payout_created payout_updated user_payout.initiated user_payout.failed user_payout.paid payout.initiated payout.failed payout.paid deposit.received return.initiated return.succeeded return.failed return.returned fx.initiated fx.succeeded fx.failed
  request-property-default-value-changed
- ○
  removed the data_session_completed enum value from the / response property for the response status
  response-property-enum-value-removed
Apr 7, 2026b58ce3f5ffe31See the full diff
- ▲
  removed the required property from the response with the status
  response-required-property-removed
Apr 1, 2026c2edd9a4d3cf1See the full diff
- ○
  added the required property to the response with the status
  response-required-property-added
This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 6, 2026d617edaf95c01See the full diff
- ○
  added the new optional header request parameter Idempotency-Key
  new-optional-request-parameter
Nov 12, 2025fd2fa66d08ac34See the full diff
- ●
  added the new fx.failed enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new fx.initiated enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new fx.succeeded enum value to the / response property for the response status
  response-property-enum-value-added
- ○
  the request property default value changed from test merchant_updated merchant_app_updated order_created order_updated refund_succeeded refund_failed refund.initiated refund.succeeded refund.failed payout_report_requested data_session_completed checkout_session_created checkout_session_updated checkout_session_expired checkout_session_completed payout_created payout_updated user_payout.initiated user_payout.failed user_payout.paid payout.initiated payout.failed payout.paid deposit.received return.initiated return.succeeded return.failed return.returned to test merchant_updated merchant_app_updated order_created order_updated refund_succeeded refund_failed refund.initiated refund.succeeded refund.failed payout_report_requested data_session_completed checkout_session_created checkout_session_updated checkout_session_expired checkout_session_completed payout_created payout_updated user_payout.initiated user_payout.failed user_payout.paid payout.initiated payout.failed payout.paid deposit.received return.initiated return.succeeded return.failed return.returned fx.initiated fx.succeeded fx.failed
  request-property-default-value-changed
- ○
  added the new fx.failed enum value to the request property /
  request-property-enum-value-added
- ○
  added the new fx.initiated enum value to the request property /
  request-property-enum-value-added
- ○
  added the new fx.succeeded enum value to the request property /
  request-property-enum-value-added
Oct 2, 20251177ad83c85f45See the full diff
- ▲
  removed the enum value mandate_revoked of the request property /
  request-property-enum-value-removed
- ▲
  removed the enum value mandate_setup_failed of the request property /
  request-property-enum-value-removed
- ▲
  removed the enum value mandate_setup_started of the request property /
  request-property-enum-value-removed
- ▲
  removed the enum value mandate_setup_succeeded of the request property /
  request-property-enum-value-removed
- ○
  the request property default value changed from test merchant_updated merchant_app_updated order_created order_updated refund_succeeded refund_failed refund.initiated refund.succeeded refund.failed payout_report_requested data_session_completed checkout_session_created checkout_session_updated checkout_session_expired checkout_session_completed payout_created payout_updated mandate_setup_started mandate_setup_succeeded mandate_setup_failed mandate_revoked user_payout.initiated user_payout.failed user_payout.paid payout.initiated payout.failed payout.paid deposit.received return.initiated return.succeeded return.failed return.returned to test merchant_updated merchant_app_updated order_created order_updated refund_succeeded refund_failed refund.initiated refund.succeeded refund.failed payout_report_requested data_session_completed checkout_session_created checkout_session_updated checkout_session_expired checkout_session_completed payout_created payout_updated user_payout.initiated user_payout.failed user_payout.paid payout.initiated payout.failed payout.paid deposit.received return.initiated return.succeeded return.failed return.returned
  request-property-default-value-changed
- ○
  removed the mandate_revoked enum value from the / response property for the response status
  response-property-enum-value-removed
- ○
  removed the mandate_setup_failed enum value from the / response property for the response status
  response-property-enum-value-removed
- ○
  removed the mandate_setup_started enum value from the / response property for the response status
  response-property-enum-value-removed
- ○
  removed the mandate_setup_succeeded enum value from the / response property for the response status
  response-property-enum-value-removed

Full history