Skip to main content
POST
/
v1
/
outbound-webhook-events
Queue an outbound webhook event
curl --request POST \
  --url http://localhost:3001/v1/outbound-webhook-events \
  --header 'Content-Type: application/json' \
  --data '
{
  "eventType": "<string>",
  "payload": {},
  "sourceKey": "<string>"
}
'
{
  "event": {
    "id": "<string>",
    "organizationId": "<string>",
    "eventType": "<string>",
    "sourceKey": "<string>",
    "endpointCount": 123,
    "payload": {},
    "deliveries": [
      {
        "id": "<string>",
        "organizationId": "<string>",
        "endpointId": "<string>",
        "endpointName": "<string>",
        "endpointUrl": "<string>",
        "attemptCount": 123,
        "responseStatusCode": 123,
        "lastError": "<string>",
        "nextRetryAt": "2023-11-07T05:31:56Z",
        "attemptedAt": "2023-11-07T05:31:56Z",
        "deliveredAt": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Headers

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

Body

application/json
eventType
string
required
Minimum string length: 1
payload
object
required
sourceKey
string
Minimum string length: 1

Response

Default Response

outcome
enum<string>
required
Available options:
queued,
duplicate
event
OutboundWebhookEventSnapshot ยท object
required