POST
/
webhooks
/
subscribe
Subscribe to a webhook event
curl --request POST \
  --url https://notificationservice.withbenji.com/webhooks/subscribe \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "endpoint": "<string>",
  "event_name": "<string>",
  "entity_type": 123
}'
{
    "code": "ok",
    "data": {
        "subscribed": true
    }
}
The Bearer token to be used on this API is your partner access token
​
endpoint
string
required
Your endpoint URL that will receive the event webhooks
​
event_name
string
The event you are subscribing to. Note that if an event is not specified, all events for the entity type specified will be subscribed to.
​
entity_type
integer
Integer representing an enum of one of the following entity type values to subscribe to :
If you do not specify an entity type or an event, you will be subscribing to all webhook events with the provided endpoint

​
Return values

​
subscribed
boolean
required
A true or false value indicating whether the subscription was succesfull.
{
    "code": "ok",
    "data": {
        "subscribed": true
    }
}