Skip to main content
POST
Create Webhook

Authorizations

Authorization
string
header
required

Server API Key (format: {keyId}:{secret})

Body

application/json
eventType
enum<string>
required

Webhook event types:

  • coupon.redeemed: Coupon redeemed
  • payment.created: Payment created
  • sponsor.created: Boost created (Sponsor)
Available options:
coupon.redeemed,
payment.created,
payment.bulk_created,
sponsor.created,
sponsor.ended
url
string<uri>
required

Webhook receiver URL

retryCount
integer
default:3

Retry count on failure

Required range: 0 <= x <= 10
timeoutMs
integer
default:5000

Timeout (milliseconds)

Required range: 1000 <= x <= 30000

Response

201 - application/json

Success (secret is only returned in this response)

data
object
required

Webhook creation response (includes secret)