Skip to main content
POST
Set Webhook

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
scope
enum<string>
required

Scope of a hook. Supported scopes are 'user_activity', 'user_reward' and 'referral'

Available options:
user_activity,
user_reward,
referral
uri
string<uri>
required

Webhook endpoint URL

secret
string

Secret used to create verification signature

hook_id
string
default:prod

Unique hook id (defaults to 'prod' if not provided)

pids
string[]

Campaign IDs to scope the webhook to specific campaigns (empty array means all campaigns)

campaign id

Response

Webhook successfully set.

success
boolean
Example:

true