Skip to content

Commit 2a5d617

Browse files
authored
Enhanced webhooks docs (#2391)
* Update webhooks.md * Updated the requested changes * Update webhooks.md
1 parent a0afe0f commit 2a5d617

File tree

1 file changed

+11
-2
lines changed
  • docusaurus/docs/dev-docs/backend-customization

1 file changed

+11
-2
lines changed

docusaurus/docs/dev-docs/backend-customization/webhooks.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ tags:
1515

1616
# Webhooks
1717

18-
Webhook is a construct used by an application to notify other applications that an event occurred. More precisely, webhook is a user-defined HTTP callback. Using a webhook is a good way to tell third party providers to start some processing (CI, build, deployment ...).
18+
Webhook is a construct used by an application to notify other applications that an event occurred. More precisely, webhook is a user-defined HTTP callback. Using a webhook is a good way to tell third-party providers to start some processing (CI, build, deployment ...).
1919

2020
The way a webhook works is by delivering information to a receiving application through HTTP requests (typically POST requests).
2121

@@ -69,7 +69,7 @@ export default {
6969
Most of the time, webhooks make requests to public URLs, therefore it is possible that someone may find that URL and send it wrong information.
7070

7171
To prevent this from happening you can send a header with an authentication token. Using the Admin panel you would have to do it for every webhook.
72-
Another way is to define `defaultHeaders` to add to every webhook requests.
72+
Another way is to define `defaultHeaders` to add to every webhook request.
7373

7474
You can configure these global headers by updating the file at `./config/server`:
7575

@@ -498,3 +498,12 @@ The event is triggered when a [release](/user-docs/releases/introduction) is pub
498498
}
499499
}
500500
}
501+
```
502+
## Best practices for webhook handling
503+
504+
- Validate incoming requests by checking headers and payload signatures.
505+
- Implement retries for failed webhook requests to handle transient errors.
506+
- Log webhook events for debugging and monitoring.
507+
- Use secure, HTTPS endpoints for receiving webhooks.
508+
- Set up rate limiting to avoid being overwhelmed by multiple webhook requests.
509+

0 commit comments

Comments
 (0)