Creating Webhooks
Set up webhooks to receive notifications when events happen on Bit Cloud. Configure the endpoint, event, and payload format.
Setting up a webhook
1
Open webhook settingsNavigate to your organization or scope settings and select Webhooks.
2
Choose an eventSelect which event should trigger the webhook. Each webhook listens to a single event type.
3
Provide your URLEnter the HTTPS endpoint that should receive the POST request. HTTP URLs are not accepted.
4
Configure the payloadChoose a pre-built template (Discord, Slack) or write a custom JSON payload with variable interpolation.
Payload templates
Pre-built templates format the payload for popular integrations:
DiscordSends a rich embed with event details, links, and user info formatted for Discord webhook channels.
SlackSends a block-formatted message with sections and context optimized for Slack incoming webhooks.
Custom payloads
Write your own JSON payload using variable interpolation. Wrap variable names in double curly braces to inject event data:
{
"text": "Export by {{username}} to {{scopeId}}",
"components": "{{componentIds}}"
}Available variables depend on the event type. Common variables include username, owner, scopeId, and componentIds.
Custom headers
Add custom HTTP headers to webhook requests for authentication or routing with external services.
Expiration
Optionally set an expiration date for a webhook. Expired webhooks are automatically deleted. You can also disable a webhook without removing it to pause notifications temporarily.