Skip to main content
POST
/
v1
/
outbound-webhook-endpoints
Create an outbound webhook endpoint
curl --request POST \
  --url http://localhost:3001/v1/outbound-webhook-endpoints \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "url": "<string>",
  "subscribedEvents": [
    "payment_intent.created"
  ],
  "status": "active"
}
'
{
  "id": "<string>",
  "organizationId": "<string>",
  "name": "<string>",
  "url": "<string>",
  "subscribedEvents": [
    "<string>"
  ],
  "hasSigningSecret": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "signingSecret": "<string>"
}

Headers

authorization
string
Minimum string length: 1
x-organization-id
string
Minimum string length: 1

Body

application/json
name
string
required
Minimum string length: 1
url
string<uri>
required
subscribedEvents
string[]
required
Minimum array length: 1
Minimum string length: 1
status
enum<string>
default:active
required
Available options:
active,
disabled

Response

Default Response

id
string
required
organizationId
string
required
name
string
required
url
string<uri>
required
subscribedEvents
string[]
required
status
enum<string>
required
Available options:
active,
disabled,
deleted
hasSigningSecret
enum<boolean>
required
Available options:
true
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
signingSecret
string
required