From eca5f6ee7bb41f40bae3f8f8bef9fb2cfef4a66a Mon Sep 17 00:00:00 2001 From: Traci Porter Date: Tue, 12 Dec 2023 11:46:12 -0600 Subject: [PATCH 1/8] DEVDOCS-5645: [update] add webhook requirements --- docs/api-docs/webhooks/about-webhooks.mdx | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/api-docs/webhooks/about-webhooks.mdx b/docs/api-docs/webhooks/about-webhooks.mdx index 928f20e7f..51599d4ca 100644 --- a/docs/api-docs/webhooks/about-webhooks.mdx +++ b/docs/api-docs/webhooks/about-webhooks.mdx @@ -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. + +BigCommerce has the following webhook requirements: + +**Limitations** +* The header 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. + + ## 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. From 03942a4f908b10d18994ce7df5aee37e0f4f6bdc Mon Sep 17 00:00:00 2001 From: Traci Porter Date: Thu, 14 Dec 2023 08:17:11 -0600 Subject: [PATCH 2/8] Update docs/api-docs/webhooks/about-webhooks.mdx Co-authored-by: Vitya Chyzhyk <33040515+6juara9@users.noreply.github.com> --- docs/api-docs/webhooks/about-webhooks.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-docs/webhooks/about-webhooks.mdx b/docs/api-docs/webhooks/about-webhooks.mdx index 51599d4ca..d0e1493c8 100644 --- a/docs/api-docs/webhooks/about-webhooks.mdx +++ b/docs/api-docs/webhooks/about-webhooks.mdx @@ -86,7 +86,7 @@ BigCommerce does not save or log any response information except response codes BigCommerce has the following webhook requirements: **Limitations** -* The header should not exceed 8 kilobytes (10 by 1 kilobytes is OK). +* 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. From d1829cbc0905c364cdfc8ffebc38a47b5d9a7864 Mon Sep 17 00:00:00 2001 From: Traci Porter Date: Thu, 14 Dec 2023 10:44:28 -0600 Subject: [PATCH 3/8] Update docs/api-docs/webhooks/about-webhooks.mdx Co-authored-by: Tina Gomez <94003415+bc-tgomez@users.noreply.github.com> --- docs/api-docs/webhooks/about-webhooks.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-docs/webhooks/about-webhooks.mdx b/docs/api-docs/webhooks/about-webhooks.mdx index d0e1493c8..bfa410554 100644 --- a/docs/api-docs/webhooks/about-webhooks.mdx +++ b/docs/api-docs/webhooks/about-webhooks.mdx @@ -81,7 +81,7 @@ Need to set up a quick webhook destination URL for testing? See [Tools for Debug ### 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. +BigCommerce doesn't save or log any response information except for response codes and doesn't recommend sending request bodies or headers in response to webhooks. BigCommerce has the following webhook requirements: From 54002aa161260a1ca0d51531246ce04627ac4726 Mon Sep 17 00:00:00 2001 From: Traci Porter Date: Thu, 14 Dec 2023 10:44:36 -0600 Subject: [PATCH 4/8] Update docs/api-docs/webhooks/about-webhooks.mdx Co-authored-by: Tina Gomez <94003415+bc-tgomez@users.noreply.github.com> --- docs/api-docs/webhooks/about-webhooks.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-docs/webhooks/about-webhooks.mdx b/docs/api-docs/webhooks/about-webhooks.mdx index bfa410554..f76c56742 100644 --- a/docs/api-docs/webhooks/about-webhooks.mdx +++ b/docs/api-docs/webhooks/about-webhooks.mdx @@ -88,7 +88,7 @@ BigCommerce has the following webhook requirements: **Limitations** * 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. +* The total number of headers shouldn't exceed 64. ## Callback retry mechanism From 7c1ef8dd954df6d0a6932dddc78f2b8bb604c51f Mon Sep 17 00:00:00 2001 From: Traci Porter Date: Thu, 14 Dec 2023 10:52:07 -0600 Subject: [PATCH 5/8] Update docs/api-docs/webhooks/about-webhooks.mdx Co-authored-by: Andrei K --- docs/api-docs/webhooks/about-webhooks.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-docs/webhooks/about-webhooks.mdx b/docs/api-docs/webhooks/about-webhooks.mdx index f76c56742..5db94cb2e 100644 --- a/docs/api-docs/webhooks/about-webhooks.mdx +++ b/docs/api-docs/webhooks/about-webhooks.mdx @@ -81,7 +81,7 @@ Need to set up a quick webhook destination URL for testing? See [Tools for Debug ### Response requirements -BigCommerce doesn't save or log any response information except for response codes and doesn't recommend sending request bodies or headers in response to webhooks. +BigCommerce doesn't recommend sending bodies or headers in response to webhooks. BigCommerce has the following webhook requirements: From 10c7f87d6bcdb2345e8601a20f9dd701c6ab5432 Mon Sep 17 00:00:00 2001 From: Traci Porter Date: Thu, 14 Dec 2023 10:52:21 -0600 Subject: [PATCH 6/8] Update docs/api-docs/webhooks/about-webhooks.mdx Co-authored-by: Andrei K --- docs/api-docs/webhooks/about-webhooks.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-docs/webhooks/about-webhooks.mdx b/docs/api-docs/webhooks/about-webhooks.mdx index 5db94cb2e..3f1e9c9d5 100644 --- a/docs/api-docs/webhooks/about-webhooks.mdx +++ b/docs/api-docs/webhooks/about-webhooks.mdx @@ -83,7 +83,7 @@ Need to set up a quick webhook destination URL for testing? See [Tools for Debug BigCommerce doesn't recommend sending bodies or headers in response to webhooks. -BigCommerce has the following webhook requirements: +BigCommerce has the following webhook response requirements: **Limitations** * The header value should not exceed 8 kilobytes (10 by 1 kilobytes is OK). From f53d2c2e32b06d8065d1340a2d34200b554fc4e9 Mon Sep 17 00:00:00 2001 From: Traci Porter Date: Thu, 14 Dec 2023 11:36:02 -0600 Subject: [PATCH 7/8] Update docs/api-docs/webhooks/about-webhooks.mdx Co-authored-by: Andrei K --- docs/api-docs/webhooks/about-webhooks.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-docs/webhooks/about-webhooks.mdx b/docs/api-docs/webhooks/about-webhooks.mdx index 3f1e9c9d5..0b2dd8bed 100644 --- a/docs/api-docs/webhooks/about-webhooks.mdx +++ b/docs/api-docs/webhooks/about-webhooks.mdx @@ -81,7 +81,7 @@ Need to set up a quick webhook destination URL for testing? See [Tools for Debug ### Response requirements -BigCommerce doesn't recommend sending bodies or headers in response to webhooks. +BigCommerce doesn't recommend sending bodies or headers in response to webhooks. It may interfere with the webhook delivery acknowledgment. BigCommerce has the following webhook response requirements: From 472a4404b0644abc2cddb1b362c568b54c1f1ba2 Mon Sep 17 00:00:00 2001 From: Traci Porter Date: Thu, 14 Dec 2023 13:00:53 -0600 Subject: [PATCH 8/8] Addressed Andrei's feedback --- docs/api-docs/webhooks/about-webhooks.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-docs/webhooks/about-webhooks.mdx b/docs/api-docs/webhooks/about-webhooks.mdx index 0b2dd8bed..5c4156bca 100644 --- a/docs/api-docs/webhooks/about-webhooks.mdx +++ b/docs/api-docs/webhooks/about-webhooks.mdx @@ -85,7 +85,7 @@ BigCommerce doesn't recommend sending bodies or headers in response to webhooks. BigCommerce has the following webhook response requirements: -**Limitations** +If you send response headers, they must conform to the following limitations for the webhook delivery to be successfully acknowledged: * The header value should not exceed 8 kilobytes (10 by 1 kilobytes is OK). * The header name should not exceed 64 characters (bytes). * The total number of headers shouldn't exceed 64.