Skip to main content
POST
/
webhooks
Error
A valid request URL is required to generate request examples
{
  "data": {
    "endpoint": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "url": "<string>",
      "status": "active",
      "programId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "schemaVersion": 2,
      "subscribedEvents": [
        "program.created"
      ],
      "secretLastFour": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "disabledAt": "2023-11-07T05:31:56Z"
    },
    "signingSecret": "<string>"
  },
  "meta": {
    "requestId": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Use API key as Bearer token, for example: Bearer ak_live_xxx

Body

application/json
name
string
required
Required string length: 1 - 100
url
string<uri>
required
subscribedEvents
enum<string>[]
required
Minimum array length: 1
Available options:
program.created,
program.updated,
affiliate.joined,
affiliate.approved,
affiliate.blocked,
affiliate.unblocked,
conversion.created,
conversion.refunded,
payout.created,
payout.processing,
payout.completed,
payout.failed,
flag.resolved
programId
string<uuid>

Response

Webhook endpoint created

data
object
required
meta
object
required