Read the JSON Bevy posts to your webhook URL: the outer envelope, default fields for each update type, fields you can add on request, and short sample payloads.
Bevy posts JSON to your HTTPS webhook URL when a subscribed record changes. Use this page for field-level shape and samples. Which actions produce a delivery is in When Bevy sends a webhook. Setup is in Configure webhooks. For verify, reply, and retry guidance, see Webhook best practices.
Payload envelope
Every delivery is a JSON array. Each item has:
-
type— A string naming the record type (attendee,user,event,eventsurveyentry,person,chapter, orchaptermember). -
data— The record body for that type.
Note: By default, Bevy sends one record per request, so data is a single object. Some communities use bulk delivery, where data is an array of records of the same type. If you receive arrays inside data, ask Bevy Support whether bulk is enabled for your community. Build your receiver to accept either shape.
Envelope example (default, one record):
[
{
"type": "attendee",
"data": {
"id": 2600,
"attendee_code": "SGA16002600"
}
}
]You can call Bevy public APIs for fields that are not in the webhook payload. For how webhooks work at a high level, see Introduction to webhooks in Bevy.
Attendee — attendee
Sent when an attendee record is created or updated and Send attendee updates is enabled. Default fields:
| Field | Description |
|---|---|
id |
Unique ID for the event registration / attendee record. |
user_id |
Bevy user ID linked to the registration, when present. |
event_id |
Event ID for the registration. |
event_chapter_id |
Chapter ID that hosts the event. |
created_date |
When the registration was created. |
checkin_date |
When the attendee was checked in, or null. |
deleted_date |
When the registration was canceled, or null. |
status |
registered, checked-in, or deleted (canceled — not a hard delete). |
first_name |
Attendee first name, or full name when the community does not use last names. |
last_name |
Attendee last name, when used. |
email |
Attendee email. On the community webhook, Bevy does not mask this value. Contact Bevy Support if you need email omitted from the payload. |
surveys |
Survey answers nested by survey type (for example pre_order, post_event, post_event_team). |
ticket_title |
Ticket type title for the registration. |
ticket_audience_type_enum_value |
Ticket venue audience: Hybrid, Virtual, or In-person. |
Attendee — fields available on request
These nested user fields are not in the default map. Ask Bevy Support to add them when you need them:
| Field | Description |
|---|---|
user.first_name |
Linked user’s first name. |
user.last_name |
Linked user’s last name. |
user.email |
Linked user’s email (not masked on the community webhook). |
user.authentication_providers |
List of auth providers, for example [{"provider": "bevy", "provider_user_id": 2600}]. |
user.company |
Linked user’s company. |
user.title |
Linked user’s job title. |
user.city |
Linked user’s city. |
user.country |
Linked user’s 2-letter country code. |
user.timezone |
Linked user’s timezone. |
user.bio |
Linked user’s biography. |
user.twitter |
Linked user’s X/Twitter handle. |
user.facebook |
Linked user’s Facebook profile URL. |
user.linkedin |
Linked user’s LinkedIn profile URL. |
user.website |
Linked user’s website URL. |
user.role |
Linked user’s system role object (id, name, description, and related role fields). |
Example:
[
{
"type": "attendee",
"data": {
"id": 1,
"first_name": "John",
"last_name": "Perez",
"email": "johnperez@example.com",
"user_id": 4,
"created_date": "2021-10-15T16:29:08Z",
"checkin_date": null,
"deleted_date": null,
"ticket_title": "RSVP",
"ticket_audience_type_enum_value": "Virtual",
"status": "registered",
"surveys": {
"pre_order": {
"created_date": "2019-05-25T19:44:24Z",
"fields": [
{ "label": "Company Size", "value": "51 - 200" }
]
}
},
"event_chapter_id": 8,
"event_id": 4
}
}
]User — user
Sent when a user profile is saved and Send user updates is enabled. Default fields:
| Field | Description |
|---|---|
id |
Unique Bevy user ID. |
first_name |
User’s first name. |
last_name |
User’s last name. |
role |
System role object: id, name, description, and user_active_status (true or false). |
email |
User email address. |
date_joined |
When the account was created. |
last_login |
Last successful login timestamp (also present when profile fields change). A login alone does not trigger a user webhook. |
deleted_date |
When the user was marked deleted, or null if active. Do not rely on the user webhook alone to detect removal — see When Bevy sends a webhook. |
User — fields available on request
| Field | Description |
|---|---|
avatar |
Avatar image object (url, thumbnail fields). |
bio |
Biography. |
company |
Company name. |
title |
Job title. |
city |
City. |
country |
2-letter country code. |
twitter |
X/Twitter handle. |
linkedin |
LinkedIn profile URL. |
facebook |
Facebook profile URL. |
website |
Website URL. |
industry |
Industry object (id, name). |
timezone |
Timezone. |
authentication_providers |
List of auth providers used by the user. |
extra_data |
Custom profile key/value pairs configured for the community. |
Example:
[
{
"type": "user",
"data": {
"id": 5,
"first_name": "John",
"last_name": "Perez",
"role": {
"id": 1,
"name": "User",
"description": "This user has standard permissions on the site.",
"user_active_status": true
},
"email": "john.perez@example.com",
"date_joined": "2022-03-11T10:51:46Z",
"last_login": "2024-01-24T16:21:58Z",
"deleted_date": null
}
}
]Event — event
Sent when an event record is created or updated and Send event updates is enabled. Default fields:
| Field | Description |
|---|---|
id |
Unique event ID. |
title |
Event title. |
status |
Draft, Published, or Canceled. |
url |
Public event page URL once published. |
description_short |
Plain-text short description. |
start_date |
Event start date/time. |
end_date |
Event end date/time. |
event_type_id |
Associated event type ID. |
event_type_title |
Associated event type title. |
published_by_full_name |
Full name of the user who published the event. |
picture |
Main event image object (url, thumbnail fields). |
chapter |
Host chapter object (location, team roster when included, URLs, and related chapter fields). |
venue_name |
Venue name. |
venue_address |
Venue street address. |
venue_city |
Venue city. |
venue_zip_code |
Venue postal code. |
get_event_address |
Concatenated venue address string. |
created_ts |
When the event record was created. |
updated_ts |
When the event record was last updated. |
key_persons |
List of key people for the event, for example [{"person_id": 123, "role": "Speaker"}]. |
allows_cohosting |
true or false — whether cohosting is allowed. |
Event — fields available on request
| Field | Description |
|---|---|
tickets |
List of ticket objects (pricing, sale window, visibility, waitlist flags). RSVP-style tickets may have no price. |
publish_date |
When the event was published. |
published_by |
Publisher user object (id, name, email). |
description |
HTML event description. |
is_hidden |
true if the event is only reachable by direct link (not listed); false if it is listed and indexable. |
total_attendees |
Registered attendee count at send time. |
checkin_count |
Checked-in attendee count at send time. |
Example:
[
{
"type": "event",
"data": {
"id": 123,
"title": "My Event Title",
"key_persons": [],
"description_short": "My Event description",
"picture": {
"url": "https://example.com/raw/event.jpg",
"thumbnail_width": 400,
"thumbnail_height": 400,
"thumbnail_url": "https://example.com/thumb/event.jpg"
},
"chapter": {
"id": 8,
"title": "Catamarca",
"chapter_location": "Catamarca (AR)",
"city": "Catamarca",
"country": "AR",
"country_name": "Argentina",
"state": "",
"timezone": "America/Argentina/Catamarca",
"url": "https://example.com/chapter-slug/",
"chapter_team": []
},
"start_date": "2023-05-01T12:29:15-03:00",
"end_date": "2023-05-01T14:28:00-03:00",
"url": "https://example.com/events/details/my-event/",
"status": "Published",
"created_ts": "2023-05-01T06:28:34Z",
"updated_ts": "2024-01-24T07:23:57Z",
"published_by_full_name": "John Perez",
"venue_name": "Community Hall",
"venue_address": "780 Main Street",
"venue_city": "Catamarca",
"venue_zip_code": "C1155",
"get_event_address": "Community Hall - 780 Main Street Catamarca, C1155",
"event_type_id": 12,
"event_type_title": "Virtual Meetup",
"allows_cohosting": false
}
}
]Event survey entry — eventsurveyentry
Sent when a survey entry is created and Send event survey entry updates is enabled. Default fields:
| Field | Description |
|---|---|
id |
Unique survey entry ID. |
survey_type |
Survey type: pre_order, post_order, post_event, or post_event_team. |
survey_id |
Survey ID for this entry. |
event_id |
Event ID the survey belongs to. |
user |
Responding user object when present (id, name, avatar fields). |
attendee |
Responding attendee object when present (id, name). |
fields |
Array of answers. Each item includes the field definition and value. |
Example:
[
{
"type": "eventsurveyentry",
"data": {
"id": 123,
"survey_type": "pre_order",
"survey_id": 943,
"event_id": 123,
"attendee": {
"id": 123,
"first_name": "Alex",
"last_name": "Lee"
},
"user": {
"id": 123,
"first_name": "John",
"last_name": "Perez",
"avatar": {}
},
"fields": [
{
"value": "Mexico",
"field": {
"label": "Country",
"field_type": "select",
"required": true,
"choices": ["Mexico", "France", "China"],
"default": "",
"help_text": ""
}
}
]
}
}
]Event people — person
Sent when a key person (speaker or similar) is created or updated and Send event people updates is enabled. Default fields:
| Field | Description |
|---|---|
id |
Unique person record ID. |
first_name |
Person’s first name. |
last_name |
Person’s last name. |
company |
Company name. |
title |
Title or role label. |
short_bio |
Bio shown on the event page. |
picture |
Person image object. |
personal_twitter |
Personal X/Twitter handle. |
company_twitter |
Company X/Twitter handle. |
user |
Linked Bevy user ID when the person is linked to a user account, or null when unlinked. This is an ID only — not the user’s email. |
Tip: Person email is not in the default payload. Ask Bevy Support if your community needs the contextual person email added.
Example:
[
{
"type": "person",
"data": {
"id": 1234,
"first_name": "John",
"last_name": "Perez",
"company": "Bevy",
"title": "Quality Assurance",
"short_bio": "John works on the Quality Assurance team.",
"picture": {
"url": "https://example.com/raw/pic.jpg",
"thumbnail_width": 200,
"thumbnail_height": 200,
"thumbnail_url": "https://example.com/thumb/pic.jpg"
},
"personal_twitter": "@jd_personal1234",
"company_twitter": "@jd_at_bevy",
"user": 55
}
}
]Chapter — chapter
Sent when a chapter record is created or updated and Send chapter updates is enabled. Default fields:
| Field | Description |
|---|---|
id |
Unique chapter ID. |
title |
Chapter name. |
chapter_location |
Display location string (city / region / country). |
city |
City. |
state |
State or province. |
country |
2-letter country code. |
country_name |
Full country name. |
description |
Chapter description (often HTML). |
timezone |
Chapter timezone. |
url |
Public chapter URL. |
chapter_team |
Array of chapter team memberships (user, role, title) included when a chapter webhook fires. |
Example:
[
{
"type": "chapter",
"data": {
"id": 8,
"title": "Test Chapter",
"chapter_location": "Parana, Entre Rios (AR)",
"city": "Parana",
"country": "AR",
"country_name": "Argentina",
"description": "Argentina chapter
",
"state": "Entre Rios",
"timezone": "America/Argentina/Cordoba",
"url": "https://example.com/test-chapter/",
"chapter_team": [
{
"id": 123,
"title": "Member",
"user": {
"id": 123,
"first_name": "John",
"last_name": "Perez",
"email": "john@example.com"
},
"role": {
"id": 123,
"name": "Check-in Staff",
"description": "Check-in permissions only"
}
}
]
}
}
]Chapter member — chaptermember
Sent when a chapter member record is created or updated and Send chapter member updates is enabled. The type value is chaptermember (one word). Default fields:
| Field | Description |
|---|---|
id |
Unique chapter member record ID. |
user |
Nested Bevy user object for the member. |
chapter |
Nested chapter object for the membership. |
created_date |
When the membership was created. |
departure_date |
When the member left the chapter, or null while still a member. |
Example:
[
{
"type": "chaptermember",
"data": {
"id": 1,
"created_date": "2021-10-18T16:07:59Z",
"departure_date": null,
"user": {
"id": 4,
"first_name": "John",
"last_name": "Perez",
"email": "john@example.com",
"full_name": "John Perez"
},
"chapter": {
"id": 8,
"title": "Test Chapter",
"chapter_location": "Parana, Entre Rios (AR)",
"city": "Parana",
"country": "AR",
"url": "https://example.com/test-chapter/"
}
}
}
]Next steps
- Confirm URL, secret, and update types in Configure webhooks.
- Map which saves produce a delivery with When Bevy sends a webhook.
- Build verify, reply, and retry handling with Webhook best practices.