Webhook Errors

​

Request Errors

The request to the /webhooks/:webhook_id endpoint failed. These are the sub_type that can be returned.

​

INVALID_REQUEST

The request body failed basic validation for the specific API endpoint.

​

NOT_FOUND

The requested resource does not exist.

​

Resource Errors

Errors set on a webhook’s error property for processes that are unsuccessful.

​

25001 – WEBHOOK_DISABLED_FAILED_OTHER

There were 5 consecutive failures when posting to the webhook url provided where error was not a 4XX, 5XX error, or a timeout.

​

Causes

• This could happen for a variety of reason types, please reach out to the team for more specific information.

{
  "type": "WEBHOOK_DISABLED",
  "code": 25001,
  "sub_type": "WEBHOOK_DISABLED_FAILED_OTHER",
  "message": "Webhook automatically disabled after failing 5 times to connect. Error was not 4XX or 5XX type."
}

​

Resolution

The webhook will be disabled and will not proceed in posting again to the provided url.

​

25002 – WEBHOOK_DISABLED_RECEIVED_4XX_ERROR

The webhook specifically received 4XX type errors when posting.

​

Causes

• Invalid resource URL
• Permission denied
• Forbidden

{
  "type": "WEBHOOK_DISABLED",
  "code": 25002,
  "sub_type": "WEBHOOK_DISABLED_RECEIVED_4XX_ERROR",
  "message": "Webhook failed 5 times with a client error (4XX type)."
}

​

Resolution

The webhook will be disabled and will not proceed in posting again to the provided url.

​

25003 – WEBHOOK_DISABLED_RECEIVED_5XX_ERROR

The webhook specifically received 5XX type errors when posting.

​

Causes

• Internal server error (from webhook url)
• Not implemented
• Bad Gateway
• Server unavailable
• Gateway timeout

{
  "type": "WEBHOOK_DISABLED",
  "code": 25003,
  "sub_type": "WEBHOOK_DISABLED_RECEIVED_5XX_ERROR",
  "message": "Webhook failed 5 times with a server error (5XX)."
}

​

Resolution

The webhook will be disabled and will not proceed in posting again to the provided url.

​

25004 – WEBHOOK_DISABLED_TIMEOUT_ON_RESPONSE

When posting a information to a webhook url, our API did not receive a valid response in the 5 second period.

​

Causes

The timeout could happen for a variety of reasons:

• Bad network or firewall config
• Long processing time on webhook receiver side

{
  "type": "WEBHOOK_DISABLED",
  "code": 25004,
  "sub_type": "WEBHOOK_DISABLED_TIMEOUT_ON_RESPONSE",
  "message": "Webhook failed 5 times in receiving a response back from the webhook url provided. Expected response time is 5 seconds."
}

​

Resolution

The webhook will be disabled and will not proceed in posting again to the provided url.

If you’ve timed out check network configs allow method servers to hit it.

Also confirm that after a payload has been posted to the webhook receiving url that successful responses are able to respond back in under 5 seconds. Typically this can be achieved by queuing the webhook data on your side and then immediately sending a 200 response back, then processing the webhook information asynchronously.