Get webhook-delivery diagnostics

Webhooks · getWebhookDelivery

GET/projects/{projectId}/webhook-deliveries/{deliveryId}

Base URL: https://api.businessmode.io/v1

Authentication

Developer bearer token

The requirement above comes from this operation's OpenAPI security declaration. See Authentication.

Parameters

Name	In	Required	Type and constraints
`projectId`	path	Yes	stringFormat: uuid · Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
`deliveryId`	path	Yes	stringFormat: uuid · Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Request body

No request body is defined.

Responses

For status codes, request IDs, and safe retry decisions, see Errors & recovery. Known-code descriptions below are operation-specific, not a complete global error enum.

`200` Successful response.

Content type: application/json

object · WebhookDeliveryDetailResponse

No additional properties

Field Type Required Description / constraints

attemptCount integer Yes Minimum: 0 · Maximum: 9007199254740991

createdAt string Yes Format: date-time · 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|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

deliveredAt

anyOf

Yes

View nested schema

anyOf

anyOf · 2 alternatives

Alternative 1

string

Format: date-time
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|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Alternative 2

null

event

object

Yes

No additional properties

View nested schema

object

No additional properties

Field Type Required Description / constraints

data object Yes

id string Yes Format: uuid · Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

occurredAt string Yes Format: date-time · 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|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

resource

object

Yes

No additional properties

View nested schema

object

No additional properties

Field	Type	Required	Description / constraints
`id`	string	Yes	Format: uuid · Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
`type`	string	Yes	Minimum length: 1

type string Yes Minimum length: 1

version integer Yes Maximum: 9007199254740991 · Exclusive minimum: 0

failedAt

anyOf

Yes

View nested schema

anyOf

anyOf · 2 alternatives

Alternative 1

string

Format: date-time
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|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Alternative 2

null

id string Yes Format: uuid · Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

lastAttemptAt

anyOf

Yes

View nested schema

anyOf

anyOf · 2 alternatives

Alternative 1

string

Format: date-time
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|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Alternative 2

null

lastErrorCode string | null Yes

lastStatusCode

anyOf

Yes

View nested schema

anyOf

anyOf · 2 alternatives

Alternative 1

integer

Minimum: 100
Maximum: 599

Alternative 2

null

nextAttemptAt

anyOf

Yes

View nested schema

anyOf

anyOf · 2 alternatives

Alternative 1

string

Format: date-time
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|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Alternative 2

null

status string Yes Values: pending, delivered, failed

webhookEndpoint

object

Yes

No additional properties

View nested schema

object

No additional properties

Field	Type	Required	Description / constraints
`id`	string	Yes	Format: uuid · Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
`name`	string	Yes	Minimum length: 1 · Maximum length: 100
`url`	string	Yes	Minimum length: 1 · Maximum length: 2048

`400` Invalid request.

Content type: application/json

object · ErrorResponse

No additional properties

Field Type Required Description / constraints

error

object

Yes

No additional properties

View nested schema

object

No additional properties

Field	Type	Required	Description / constraints
`code`	string	Yes	Minimum length: 1
`message`	string	Yes	Minimum length: 1

`401` Authentication failed.

Content type: application/json

object · ErrorResponse

No additional properties

Field Type Required Description / constraints

error

object

Yes

No additional properties

View nested schema

object

No additional properties

Field	Type	Required	Description / constraints
`code`	string	Yes	Minimum length: 1
`message`	string	Yes	Minimum length: 1

`404` The authorized resource was not found.

Content type: application/json

object · ErrorResponse

No additional properties

Field Type Required Description / constraints

error

object

Yes

No additional properties

View nested schema

object

No additional properties

Field	Type	Required	Description / constraints
`code`	string	Yes	Minimum length: 1
`message`	string	Yes	Minimum length: 1

`429` Too many requests. Honor Retry-After before retrying with the same logical Idempotency-Key, where required. Known error codes: rate_limit_exceeded.

Content type: application/json

object · ErrorResponse

No additional properties

Field Type Required Description / constraints

error

object

Yes

No additional properties

View nested schema

object

No additional properties

Field	Type	Required	Description / constraints
`code`	string	Yes	Minimum length: 1
`message`	string	Yes	Minimum length: 1

`500` An unexpected server error occurred.

Content type: application/json

object · ErrorResponse

No additional properties

Field Type Required Description / constraints

error

object

Yes

No additional properties

View nested schema

object

No additional properties

Field	Type	Required	Description / constraints
`code`	string	Yes	Minimum length: 1
`message`	string	Yes	Minimum length: 1

← All API operations

Company access

Manage customers

Company sales

Beyond manual work

Get started

Reference

Build

Company access

Explore the choices

Get webhook-delivery diagnostics

Authentication

Parameters

Request body

Responses

`200` Successful response.

`400` Invalid request.

`401` Authentication failed.

`404` The authorized resource was not found.

`429` Too many requests. Honor Retry-After before retrying with the same logical Idempotency-Key, where required. Known error codes: rate_limit_exceeded.

`500` An unexpected server error occurred.

Get webhook-delivery diagnostics

Authentication

Parameters

Request body

Responses

200 Successful response.

400 Invalid request.

401 Authentication failed.

404 The authorized resource was not found.

429 Too many requests. Honor Retry-After before retrying with the same logical Idempotency-Key, where required. Known error codes: rate_limit_exceeded.

500 An unexpected server error occurred.

`200` Successful response.

`400` Invalid request.

`401` Authentication failed.

`404` The authorized resource was not found.

`429` Too many requests. Honor Retry-After before retrying with the same logical Idempotency-Key, where required. Known error codes: rate_limit_exceeded.

`500` An unexpected server error occurred.