POST
/
api
/
service
/
webhook-subscription
/
create
curl --request POST \
  --url https://api.sand.getivy.de/api/service/webhook-subscription/create \
  --header 'Content-Type: application/json' \
  --header 'X-Ivy-Api-Key: <api-key>' \
  --data '{
  "url": "<string>",
  "events": [
    "test"
  ]
}'
{
  "id": "<string>",
  "merchant": "<string>",
  "merchantApp": "<string>",
  "url": "<string>",
  "events": [
    "test"
  ],
  "updatedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-Ivy-Api-Key
string
header
required

Body

application/json
​
url
string
required

The endpoint where webhook events are sent.

​
events
enum<string>[]
required

The events to subscribe the url to.

Available options:
test,
merchant_updated,
merchant_app_updated,
order_created,
order_updated,
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.failed,
user_payout.paid,
user_payout.initiated

Response

200 - application/json
Returns the new webhook subscription.
​
id
string
required

The unique id for the webhook subscription.

​
merchant
string
required

The unique id for the webhook subscription.

​
merchantApp
string
requireddeprecated

The unique id for the webhook subscription.

​
url
string
required

The url that will listen to the webhook events coming from Ivy. Must be unique for the merchant app.

​
events
enum<string>[]
required
Available options:
test,
merchant_updated,
merchant_app_updated,
order_created,
order_updated,
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.failed,
user_payout.paid,
user_payout.initiated
​
updatedAt
string
required
​
createdAt
string
required
Trigger a specific webhookDelete a webhook subscription