Skip to main content
POST
Create a webhook
OAuth scope: webhook_writeAPI keys have full access to this endpoint.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
url
string
required
allowedTypes
enum<string>[]
required
Available options:
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

Response

OK

id
string
required
url
string
required
allowedTypes
enum<string>[]
required
Available options:
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
apiVersion
enum<string>
required
Available options:
V1