How are webhook payload sent?

The data format used for the webhook's response will be JSON.

The JSON payload will have a consistent format for all webhooks of the same type that you can find in the next sections.

The payload will include batch data within the same type (e.g., a list of attendees records).

The format will consist of:

• data: An array with the details of the object(s) that were updated.
• type: A string with the object(s) type included in the payload.

Example:

[
  {
    "data": [
      {
        "id": 2600,
        "attendee_code": "SGA16002600",
        ...
      },
      {
        "id": 2601,
        "attendee_code": "SGA16002601",
        ...
      }
    ],
    "type": "attendee"
  }
]

You can use Bevy APIs to add any extra information that wasn't included in the payload.

Attendee updates

Bevy will send a list of all attendee records that are created or updated. Updates will include details that changed, like Featured Attendee requests, or check-in status updates.

The payload will be identified under the type of "attendee", and by default the details will include the following fields:

Attendee updates — Extra Data

There are other fields related to the registration that can be included in the payload. By default, Bevy does not include them, but they’re available upon request. Those fields are:

[
  {
    "provider": "bevy",
    "provider_user_id": 2600 
  },
  {
    "provider": "facebook",
    "provider_user_id": "abcd1234"
  }, 
  ...
] 

{
  "id": 1,
  "name": "User",
  "description": "This user has standard permissions on the site."
}

Example of attendee updates payload

[
  {
    "type": "attendee",
    "data": [
      {
        "id": 1,
        "first_name": "John",
        "last_name": "Perez",
        "email": "johnperez@mmail.com",
        "user_id": 4,
        "created_date": "2021-10-15T16:29:08Z",
        "checkin_date": null,
        "deleted_date": "2021-10-18T16:04:40Z",
        "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"
              }, 
              {
                "label": "Gender", 
                "value": "Male"
              }
            ]
          }
        },
        "event_chapter_id": 8,
        "event_id": 4
      }
    ]
  }
]  

User updates

Bevy will send you a list of all user records that are created or updated.

The payload will be identified under the type of "user", and by default the details will include the following fields:

{
  "id": 1,
  "name": "User",
  "description": "This user has standard permissions on the site."
  "user_active_status": "Status o the user either active or inactive
}

User updates — Extra Data

There are other fields related to the user that can be included in the payload.

By default, Bevy does not include them, but they’re available upon request. Those fields are:

{
  "url": "https://example.com/raw/pic.jpg",
  "thumbnail_width": 200,
  "thumbnail_height": 200,
  "thumbnail_url": "https://example.com/thumb/pic.jpg",
  "avatar": {...}
}

{
  "id": 39,
  "name": "Events Services"
}

[
  {
    "provider": "bevy",
    "provider_user_id": 2600 
  },
  {
    "provider": "linkedin",
    "provider_user_id": "Jd8a8jda"
  }
]

{
  "favorite_food": "Pizza",
  "favorite_color": "Blue"
}

Example of user updates payload

[
  {
    "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@mail",
        "date_joined": "2022-03-11T10:51:46Z",
        "last_login": "2024-01-24T16:21:58Z",
        "deleted_date": null
      }
    ]
  }
]

Event updates

Bevy will send you a list of all event records that are created or updated. Updates will include details that changed, including event completion.

The payload will be identified under the type of "event", and by default the details will include the following fields:

{
  "url": "https://example.com/raw/event.jpg",
  "thumbnail_width": 400,
  "thumbnail_height": 400,
  "thumbnail_url": "https://example.com/thumb/event.jpg"
}

{
  "chapter_location": "Catamarca (AR)",
  "city": "Catamarca",
  "country": "AR",
  "country_name": "Argentina",
  "description": "<p>Cras ac mattis ligula, sit amet pulvinar dui.</p>",
  "id": 8,
  "hide_country_info": false,
  "logo": {},
  "chapter_team": [
    {
      "id": 22,
      "user": {},
      "role": {},
      "title": "Chapter leader"
    }
  ],
  "state": "",
  "timezone": "Pacific/Niue",
  "title": "John Perez",
  "relative_url": "/chapter-slug/",
  "url": "https://bevy.bevylabs.com/chapter-slug/"
}

[
  {
    "person_id": 123,
    "role": "Speaker"
  }, ... 
]

Event updates — Extra Data

There are other fields related to the event that can be included in the payload.

By default, Bevy does not include them, but they’re available upon request. Those fields are:

[
  {
    "id": 2146,
    "title": "VIP",
    "description": "Get a reserved seat and other perks.",
    "sale_start_date": "2018-07-15T08:54:00-05:00",
    "sale_end_date": "2018-10-15T21:00:00-05:00",
    "min_per_order": 1,
    "max_per_order": 4,
    "price": 10.0,
    "currency": "USD",
    "is_for_sale": false,
    "visible": true,
    "waitlist_enabled": false
  }, ... 
] 

{
  "id": 2600,
  "first_name": "John",
  "last_name": "Smith",
  "email": "john.smith@example.com"
}

Example of event update payload

[
  {
    "type": "event",
    "data": [
      {
        "id": 123,
        "title": "My Event Title",
        "key_persons": [],
        "description_short": "My Event description",
        "picture": {
          "url": "...",
          "path": "...",
          "thumbnail_width": 400,
          "thumbnail_height": 400,
          "thumbnail_format": "auto",
          "thumbnail_url": "..."
        },
        "chapter": {
          "chapter_location": "Catamarca (AR)",
          "city": "Catamarca",
          "country": "AR",
          "country_name": "Argentina",
          "description": "<p>Cras ac mattis ligula, sit amet pulvinar dui.</p>",
          "id": 8,
          "hide_country_info": false,
          "logo": {},
          "chapter_team": [
            {
              "id": 22,
              "user": {},
              "role": {},
              "title": "Chapter leader"
            }
          ],
          "state": "",
          "timezone": "Pacific/Niue",
          "title": "John Perez",
          "relative_url": "/chapter-slug/",
          "url": "https://bevy.bevylabs.com/chapter-slug/"
        },
        "start_date": "2023-05-01T12:29:15-09:00",
        "end_date": "2024-03-30T12:28:00-09:00",
        "url": "https://bevy.bevylabs.com/events/details/chapter-slug-presents-my-event/",
        "status": "Published",
        "created_ts": "2023-05-11T06:28:34.479747-09:00",
        "updated_ts": "2024-01-24T07:23:57.064179-09:00",
        "published_by_full_name": "John Perez",
        "venue_name": "Boca Juniors",
        "venue_address": "780 Avenida Almirante Brown",
        "venue_city": "C1155AER",
        "venue_zip_code": "C1155",
        "get_event_address": "Boca Juniors - 780 Avenida Almirante Brown C1155AER, C1155",
        "event_type_title": "Virtual Event type",
        "allows_cohosting": false
      }
    ]
  }
]

Event survey entry updates

Bevy will send you a list of all event survey entry records that are created: pre-order, post-event, and post-event team.

The payload will be identified under the type of "eventsurveyentry", and by default the details will include the following fields:

{
  "id": 2345,
  "first_name": "John",
  "last_name": "Doe",
  "avatar": {...}
}

{
  "id": 1234,
  "first_name": "John",
  "last_name": "Doe"
}

[
  {
    "field":
      {
        "choices": [],
        "default": "",
        "field_type": "number",
        "help_text": "",
        "label": "Enter a number:",
        "required": True
      },
    "value": "Answer 1"
  }, 
  ...
]

Example of event survey entry updates payload

[
  {
    "type": "eventsurveyentry",
    "data": [
      {
        "id": 123,
        "survey_type": "pre_order",
        "event_id": 123,
        "attendee": {
          "id": 123,
          "first_name": "Atend",
          "last_name": "Deee"
        },
        "user": {
          "id": 123,
          "first_name": "John",
          "last_name": "Perez",
          "avatar": {
            "url": "...",
            "path": "...",
            "thumbnail_width": 400,
            "thumbnail_height": 400,
            "thumbnail_format": "auto",
            "thumbnail_url": "..."
          }
        },
        "fields": [
          {
            "value": "Mexico",
            "field": {
              "label": "Country",
              "field_type": "select",
              "required": true,
              "choices": ["Mexico","France","China"],
              "default": "",
              "help_text": ""
            }
          },
        ],
        "survey_id": 943
      }
    ]
  }
]

Event people updates

Bevy will send you a list of all key people's records that are created or updated. Key people are records that include general information about a person related to one or more events, such as speakers.

The payload will be identified under the type of "person", and by default the details will include the following fields:

{
  "url": "https://example.com/raw/pic.jpg",
  "thumbnail_width": 200,
  "thumbnail_height": 200,
  "thumbnail_url":
  "https://example.com/thumb/pic.jpg",
  "avatar": {...}
}

Example of event people updates payload

[
  {
    "type": "person",
    "data": [
      {
        "id": 1234,
        "first_name": "John",
        "last_name": "Perez",
        "company": "Bevy",
        "title": "Quality Assurance",
        "short_bio": "John Doe is 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",
      } 
    ]
  }
]

Chapter updates

The payload will be identified under the type of "chapter", and by default the details will include the following fields:

Example of chapter updates payload

[
  {
    "type": "chapter",
    "data": [{
      "chapter_location": "Parana, Entre Rios (AR)",
      "city": "Parana",
      "country": "AR",
      "country_name": "Argentina",
      "description": "<p>Agentina chapter</p>",
      "id": 8,
      "chapter_team": [{
        "id": 123,
        "user": {
          "id": 123,
          "first_name": "John",
          "last_name": "Perez",
          "company": "",
          "email": "p*****@grillo.com"
        },
        "role": {
          "id": 123,
          "name": "Check-in Staff",
          "description": "Check-in permissions only",
          "permissions": [],
          "visible": true
        },
        "title": "Member"
      }],
      "state": "Entre Rios",
      "timezone": "America/Argentina/Cordoba",
      "title": "Test Chapter",
      "url": "http://localhost:8000/test-chapter/"
    }]
  }
]

Chapter member updates

The payload will be identified under the type of "chapter_member", and by default the details will include the following fields:

Example of chapter member updates payload

[
  {
    "type": "chaptermember",
    "data": {
      "id": 1,
      "user": {
        "id": 4,
        "first_name": "John",
        "last_name": "Perez",
        "avatar": {},
        "title": "",
        "company": "",
        "role": {
          "id": 1,
          "name": "User",
          "description": "This user has standard permissions on the site.",
          "user_active_status": true
        },
        "full_name": "John Perez",
        "email": "j********@mail.com",
        "city": "",
        "twitter": null,
        "linkedin": "",
        "country": "",
        "industry": null,
        "timezone": null,
        "bio": null,
        "website": "",
        "facebook": "",
        "profile_url": "/u/m6vyv6/"
      },
      "chapter": {
        "id": 8,
        "chapter_location": "Parana, Entre Rios (AR)",
        "city": "Parana",
        "country": "AR",
        "country_name": "Argentina",
        "description": "<p>Agentina chapter</p>",
        "chapter_team": [],
        "state": "Entre Rios",
        "timezone": "America/Argentina/Cordoba",
        "title": "Test Chapter",
        "url": "https://bevy.bevylabs.com/test-chapter/"
      },
      "created_date": "2021-10-18T16:07:59Z"
    }
  }
]