Skip to main content
POST
/
v1
/
outbound-webhook-deliveries
/
{outboundWebhookDeliveryId}
/
attempts
Record an outbound webhook delivery attempt
curl --request POST \
  --url http://localhost:3001/v1/outbound-webhook-deliveries/{outboundWebhookDeliveryId}/attempts \
  --header 'Content-Type: application/json' \
  --data '
{
  "responseStatusCode": 349,
  "responseBody": {},
  "lastError": "<string>",
  "nextRetryAt": "2023-11-07T05:31:56Z"
}
'
{
  "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

Path Parameters

​
outboundWebhookDeliveryId
string
required
Minimum string length: 1

Body

application/json
​
status
enum<string>
required
Available options:
pending,
retry_scheduled,
delivered,
failed
​
responseStatusCode
integer | null
Required range: 100 <= x <= 599
​
responseBody
object
​
lastError
string | null
Minimum string length: 1
​
nextRetryAt
string<date-time> | null
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Response

Default Response

​
id
string
required
​
organizationId
string
required
​
eventType
string
required
​
sourceKey
null | string
required
​
status
enum<string>
required
Available options:
pending,
delivered,
failed,
skipped
​
endpointCount
integer
required
​
payload
object
required
​
deliveries
OutboundWebhookDeliverySnapshot · object[]
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required