Register an analytics webhook

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Examples

REQUEST
Accept: application/json

RESPONSE
201 (OK)
{
  "webhook_id": 1,
  "status": "Successfully registered the webhook"
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String

url
required

Target Url

Validations:

  • Must be a String

security_key
required

A secure token that will be sent along for validation of request authenticity

Validations:

  • Must be a String

event_subscriptions
required

Events that webhook subscribes to

Validations:

  • Must be an array of any type