Set your HTTPS endpoint, shared secret, and update types in Admin Dashboard → Settings → General → Webhooks so Bevy can push JSON when subscribed records change.
Use this page when you are ready to turn on Bevy webhooks for your community. For how webhooks work and when to use them instead of the public API, see Introduction to webhooks in Bevy and Choose the public API or webhooks.
Before you start
- You need Admin access to the Admin Dashboard.
- You need an HTTPS endpoint that can accept POST requests from Bevy. HTTP URLs are not allowed.
- Decide which update types to enable (for example attendees and events). Field-level payload shape lives in Webhook payloads — this page does not include sample JSON.
Open Webhooks settings
- In the Admin Dashboard, open Settings in the left sidebar.
- On the General tab, scroll to the Webhooks section.
Set the destination URL
- In the URL field, enter the HTTPS address where Bevy should send updates.
- Confirm the address uses
https://. Bevy rejects non-HTTPS URLs.
Set the shared secret
Bevy can send a shared secret as a request header so your receiver can verify that the POST came from Bevy.
- In Webhooks Secret Key, enter the header name Bevy should use. The name must start with
x-orX-. The default isX-BEVY-SECRET. - In Webhooks Secret, enter the secret value Bevy should send in that header. Leave it blank only if you are not verifying the header yet — a shared secret is strongly recommended for production receivers.
Tip: Your receiver should read the header named in Webhooks Secret Key and compare it to the value in Webhooks Secret. Details for verification, acknowledgment, and retries are in Webhooks best practices.
Choose update types
Use the checkboxes to choose which record changes Bevy should push to your URL. Defaults when you have not changed the settings:
| Setting | Default | Sends updates for |
|---|---|---|
| Send attendee updates | On | Event attendees |
| Send event updates | On | Events |
| Send user updates | Off | Users |
| Send event survey entry updates | Off | Event survey entries |
| Send event people updates | Off | Event people (speakers, hosts, and similar roles) |
| Send chapter updates | Off | Chapters |
| Send chapter member updates | Off | Chapter members |
Turn on only the types your integration needs. Enabling every type increases volume and processing work on your endpoint.
Note: For which saves produce a delivery, see When are webhook payloads sent?. For the JSON fields in each payload, see Webhook payloads.
Save your settings
- Click Save Settings.
- Trigger a test change for a type you enabled (for example update a test event or attendee) and confirm your endpoint receives the POST.
- Verify the secret header on the request, then process the payload using your own rules.
Important: Saving these settings does not send a one-time backfill of historical records. Bevy pushes when subscribed records change after webhooks are configured. Your receiver should filter older records if you only care about new activity.
Next steps
- Implement verification and fast acknowledgment with Webhooks best practices.
- Map fields with Webhook payloads.
- Confirm timing with When are webhook payloads sent?.