Skip to main content
POST
/
open-api
/
v1.0
/
webhooks
Create a webhook
curl --request POST \
  --url https://api.fourthwall.com/open-api/v1.0/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "allowedTypes": [
    "ORDER_PLACED"
  ]
}
'
{
  "id": "<string>",
  "url": "<string>",
  "allowedTypes": [
    "ORDER_PLACED"
  ],
  "apiVersion": "V1"
}
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_CREATED,
COLLECTION_UPDATED

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_CREATED,
COLLECTION_UPDATED
​
apiVersion
enum<string>
required
Available options:
V1