Skip to content

Webhook Errors

All errors conform to the following schema:

Name Type Optional Description
status string false Unique identifier of the error
message string false Description of the error
context object true Additional values describing the error

Error Status Index

Status Schema
auth_unauthorized UnauthorizedError
forbidden ForbiddenError
request_validation_error RequestValidationError
webhook_delivery_not_found WebhookDeliveryNotFoundError
webhook_endpoint_not_found WebhookEndpointNotFoundError
webhook_event_not_found WebhookEventNotFoundError

ForbiddenError

status: forbidden

The request is not authorized.

Example

1
2
3
4
{
  "status": "forbidden",
  "message": "Forbidden"
}

UnauthorizedError

status: auth_unauthorized

The request is not authorized.

Example

1
2
3
4
{
  "status": "auth_unauthorized",
  "message": "Unauthorized"
}

WebhookDeliveryNotFoundError

status: webhook_delivery_not_found

WebhookManagementError()

Example

1
2
3
4
5
6
7
{
  "status": "webhook_delivery_not_found",
  "message": "Webhook delivery with id {delivery_id} is not found.",
  "context": {
    "delivery_id": "9892f438-d31c-4ff2-bc84-146525b292ff"
  }
}

Context

Name Type Optional Description
delivery_id string(uuid) false The uuid of the delivery.

WebhookEndpointNotFoundError

status: webhook_endpoint_not_found

WebhookManagementError()

Example

1
2
3
4
5
6
7
{
  "status": "webhook_endpoint_not_found",
  "message": "Webhook endpoint with id {endpoint_id} is not found.",
  "context": {
    "endpoint_id": "e9ce0d4f-d433-423d-9497-4c000544106c"
  }
}

Context

Name Type Optional Description
endpoint_id string(uuid) false The uuid of the endpoint.

WebhookEventNotFoundError

status: webhook_event_not_found

WebhookManagementError()

Example

1
2
3
4
5
6
7
{
  "status": "webhook_event_not_found",
  "message": "Webhook event with id {event_id} is not found.",
  "context": {
    "event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7"
  }
}

Context

Name Type Optional Description
event_id string(uuid) false The uuid of the event.

RequestValidationError

status: request_validation_error

Returned when the request payload failed validation.

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "status": "request_validation_error",
  "message": "Failed to validate request",
  "context": [
    {
      "location": [
        "body",
        "config",
        "model"
      ],
      "message": "field required",
      "status": "value_error.missing"
    }
  ]
}

Context

Name Type Optional Description
Context [object] true -
Parameter object true -
» location [string] false Location of the error
» message string false The description of the error
» status string false The type of validation error that occurred