Skip to content
This repository has been archived by the owner on Jan 10, 2025. It is now read-only.

DEVDOCS-5645: [update] add webhook requirements #2114

Merged
merged 9 commits into from
Dec 15, 2023
12 changes: 12 additions & 0 deletions docs/api-docs/webhooks/about-webhooks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,18 @@ To acknowledge a callback has been received without issue, the destination serve

Need to set up a quick webhook destination URL for testing? See [Tools for Debugging and Testing Webhooks](#tools).

### Response requirements

BigCommerce does not save or log any response information except response codes and does not recommend sending request bodies or headers in response to webhooks.
bc-traciporter marked this conversation as resolved.
Show resolved Hide resolved

BigCommerce has the following webhook requirements:
bc-traciporter marked this conversation as resolved.
Show resolved Hide resolved

**Limitations**
zvuki marked this conversation as resolved.
Show resolved Hide resolved
* The header value should not exceed 8 kilobytes (10 by 1 kilobytes is OK).
* The header name should not exceed 64 characters (bytes).
* The number of headers should not be larger than 64.
bc-traciporter marked this conversation as resolved.
Show resolved Hide resolved


## Callback retry mechanism

The webhooks service will do its best to deliver events to the destination callback URI. It is best practice for the application to respond to the callback before taking any other action that would slow its response. Doing otherwise triggers BigCommerce's callback retry mechanism.
Expand Down