Skip to main content
POST
/
v2
/
webhooks
/
endpoints
Create a webhook endpoint
curl --request POST \
  --url https://api.example.com/v2/webhooks/endpoints \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "description": "<string>",
  "eventTypes": [
    "<string>"
  ]
}
'
{
  "id": "<string>",
  "organizationId": "<string>",
  "url": "<string>",
  "description": "<string>",
  "active": true,
  "eventTypes": [
    "<string>"
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "signingSecret": "<string>"
}

Body

application/json
url
string<uri>
required
Maximum string length: 2048
description
string
Maximum string length: 255
eventTypes
string[]

Response

201 - application/json
id
string
required
Pattern: ^wep_[0-9A-Za-z]{22}$
organizationId
string
required
Pattern: ^org_[0-9A-Za-z]{22}$
url
string
required
description
string | null
required
active
boolean
required
eventTypes
string[] | null
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
deletedAt
string<date-time> | null
required
signingSecret
string
required