---
title: "Changes to Create a webhook subscription"
method: POST
path: "/api/service/webhook-subscription/create"
---

# Changes to Create a webhook subscription

`POST /api/service/webhook-subscription/create`

> Every recorded change to this endpoint, newest first.

## Timeline

Changed in 6 of 52 revisions.

- **2026-08-25** `a2c2fbc14f4b` — 1 breaking, 2 info
- **2026-04-07** `b58ce3f5ffe3` — 1 breaking
- **2026-04-01** `c2edd9a4d3cf` — 1 info
- **2026-03-06** `d617edaf95c0` — 1 info
- **2025-11-12** `fd2fa66d08ac` — 3 warning, 4 info
- **2025-10-02** `1177ad83c85f` — 4 breaking, 5 info

## Changes

- **2026-08-25** `a2c2fbc14f4b` — 1 breaking, 2 info
  - removed the enum value `data_session_completed` of the request property `events/items/`
  - the `events` 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`
  - removed the `data_session_completed` enum value from the `events/items/` response property for the response status `200`
- **2026-04-07** `b58ce3f5ffe3` — 1 breaking
  - removed the required property `apiSurface` from the response with the `200` status
- **2026-04-01** `c2edd9a4d3cf` — 1 info
  - added the required property `apiSurface` to the response with the `200` status
- **2026-03-06** `d617edaf95c0` — 1 info
  - added the new optional `header` request parameter `Idempotency-Key`
- **2025-11-12** `fd2fa66d08ac` — 3 warning, 4 info
  - added the new `fx.failed` enum value to the `events/items/` response property for the response status `200`
  - added the new `fx.initiated` enum value to the `events/items/` response property for the response status `200`
  - added the new `fx.succeeded` enum value to the `events/items/` response property for the response status `200`
  - the `events` 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`
  - added the new `fx.failed` enum value to the request property `events/items/`
  - added the new `fx.initiated` enum value to the request property `events/items/`
  - added the new `fx.succeeded` enum value to the request property `events/items/`
- **2025-10-02** `1177ad83c85f` — 4 breaking, 5 info
  - removed the enum value `mandate_revoked` of the request property `events/items/`
  - removed the enum value `mandate_setup_failed` of the request property `events/items/`
  - removed the enum value `mandate_setup_started` of the request property `events/items/`
  - removed the enum value `mandate_setup_succeeded` of the request property `events/items/`
  - the `events` 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`
  - removed the `mandate_revoked` enum value from the `events/items/` response property for the response status `200`
  - removed the `mandate_setup_failed` enum value from the `events/items/` response property for the response status `200`
  - removed the `mandate_setup_started` enum value from the `events/items/` response property for the response status `200`
  - removed the `mandate_setup_succeeded` enum value from the `events/items/` response property for the response status `200`

---

[Operation](https://skmtc.dev/augustus/apis/ivy-api/docs/api/service/webhook-subscription/create/post.md) · [API](https://skmtc.dev/augustus/apis/ivy-api.md) · [Page](https://skmtc.dev/augustus/apis/ivy-api/changes/api/service/webhook-subscription/create/post)