Webhook-Event
- POSTTest
- POSTOrder Created
- POSTOrder Updated
- POSTMerchant Updated
- POSTRefund Succeeded
- POSTRefund Failed
- POSTUser Payout Initiated
- POSTUser Payout Paid
- POSTUser Payout Failed
- POSTPayout Report Requested
- POSTData Session Completed
- POSTCheckout Session Created
- POSTCheckout Session Updated
- POSTCheckout Session Expired
- POSTCheckout Session Completed
- POSTPayout Created
- POSTPayout Updated
- POSTMandate Setup Started
- POSTMandate Setup Succeeded
- POSTMandate Setup Failed
- POSTMandate Revoked
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
Copy
Ask AI
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",
"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.initiated",
"user_payout.failed",
"user_payout.paid"
]
}'
Copy
Ask AI
{
"id": "<any>",
"merchant": "<any>",
"merchantApp": "<any>",
"url": "<string>",
"events": [
"test"
],
"createdAt": "<any>",
"updatedAt": "<any>"
}
Authorizations
API key for authentication
Body
application/json
Response
200 - application/json
Returns the new webhook subscription.
The response is of type object
.
Copy
Ask AI
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",
"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.initiated",
"user_payout.failed",
"user_payout.paid"
]
}'
Copy
Ask AI
{
"id": "<any>",
"merchant": "<any>",
"merchantApp": "<any>",
"url": "<string>",
"events": [
"test"
],
"createdAt": "<any>",
"updatedAt": "<any>"
}
Assistant
Responses are generated using AI and may contain mistakes.