POST
/
v2
/
webhooks
curl --request POST \
  --url https://api.whop.com/api/v2/webhooks \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "<string>",
  "enabled": true,
  "events": [
    ""
  ]
}'
{
  "id": "<string>",
  "enabled": true,
  "url": "<string>",
  "created_at": "<string>"
}

Headers

​
Authorization
string

Your API key, which can be found on the Whop Business Dashboard. You must prepend your key with the word 'Bearer', which will look like Bearer ***************************

Body

application/json

Create a Webhook

​
url
string
required

The URL where new Webhook events will be sent to (e.g. https://website.com/api/whop-webhook)

​
enabled
boolean
default:true

Whether or not the specified Webhook is enabled/turned on for new event notifications

​
events
enum<string>[]

An array of the events the webhook will fire for. By default all events are enabled.

Available options:
membership_went_valid,
membership_went_invalid,
membership_metadata_updated,
payment_succeeded,
payment_failed,
refund_created,
refund_updated,
dispute_created,
dispute_updated,
membership_cancel_at_period_end_changed,
payment_affiliate_reward_created,
membership_experience_claimed,
app_membership_went_valid,
app_membership_went_invalid,
app_payment_succeeded,
app_payment_failed,
app_membership_cancel_at_period_end_changed

Response

201 - application/json
Create a Webhook

Webhook model

​
id
string

The ID of the Webhook, which will look like hook_*************

​
enabled
boolean

Whether or not the specified Webhook is enabled/turned on for new event notifications

​
url
string

The URL where new Webhook events will be sent to (e.g. https://website.com/api/whop-webhook)

​
created_at
string

The time at which the Webhook was created. Measured in seconds since the Unix epoch.

Was this page helpful?