Sign in

v2

latestOpenAPI 3.1.02026-07-26102336742.6 KB
Webhooks

Get a webhook event

Rate limit: 100 requests / 10 seconds per shop. See Rate limiting.

Get a single webhook event by ID

get/open-api/v1.0/webhook-events/{webhookEventId}

Path parameters

webhookEventIdstring required

Response

OK

idstring required

Event ID

type'ORDER_PLACED' | 'ORDER_UPDATED' | 'GIFT_PURCHASE' | 'PRODUCT_CREATED' | 'PRODUCT_UPDATED' | 'DONATION' | 'SUBSCRIPTION_PURCHASED' | 'SUBSCRIPTION_EXPIRED' | 'SUBSCRIPTION_CHANGED' | 'NEWSLETTER_SUBSCRIBED' | 'THANK_YOU_SENT' | 'GIFT_DRAW_STARTED' | 'GIFT_DRAW_ENDED' | 'PROMOTION_CREATED' | 'PROMOTION_UPDATED' | 'PROMOTION_STATUS_CHANGED' | 'PLATFORM_APP_DISCONNECTED' | 'MEMBERSHIP_POST_UPSERTED' | 'MEMBERSHIP_SERIES_UPSERTED' | 'MEMBERSHIP_SERIES_DELETED' | 'MEMBERSHIP_TAG_CREATED' | 'MEMBERSHIP_TAG_UPDATED' | 'MEMBERSHIP_TAG_DELETED' | 'MEMBERSHIP_TIER_UPSERTED' | 'MEMBERSHIP_TIER_DELETED' | 'COLLECTION_UPDATED' | 'CART_ABANDONED_1H' | 'CART_ABANDONED_24H' | 'CART_ABANDONED_72H' required

Event type

apiVersion'V1' required

API version

createdAtstring date-time required

When the event was created

updatedAtstring date-time required

When the event was last updated

bodystring required

Event body as JSON string

testModeboolean required

Whether this is a test mode event

statestring required

Event state

errorstring

Error message if delivery failed

urlstring required

URL