---
title: Event Payload
slug: docs/event-payload
createdAt: 2023-03-09T01:24:50.000Z
---



# Overview

When an event, such as "Sonic Conference" (example) is added or edited in Jomablue, a SNS message is published to a Jomablue-owned SNS topic, and the *value* of the ‘message’ key in the SNS message will contain the following structure.&#x20;

:::hint{type="info"}
Note that if category names change, or new categories are added or removed, the following is also generated and published. This resource will always contain the latest category data for an event.&#x20;
:::



### Attributes

A description of each attribute in the event payload is below:



- `resource_type`   string
  Must be ‘event’.&#x20;
- `generated_at`   timestamp
  Timestamp in the following format: 2025-07-02T19:15:12.511Z.
- `identifiers`  **object**
  - `id`   string
    A unique identifier. Alphanumeric (upper and lower case), hyphens, forward slash and underscores. No whitespace.&#x20;
- `data`   **object**
  - `name`   string
    Alphanumeric (upper and lower case), special characters and whitespace.
  - `start_time`   timestamp
    Timestamp in the following format: 2025-07-02T19:15:12.511Z
  - `end_time`   timestamp
    Timestamp in the following format: 2025-07-02T19:15:12.511Z
  - `short_description`   string
    Alphanumeric (upper and lower case), special characters and whitespace.
  - `description`   string
    Alphanumeric (upper and lower case), special characters and whitespace.
  - `person_count_goal`   integer
    A positive number.
  - `venue_name`   string
    Alphanumeric (upper and lower case), special characters and whitespace.
  - `venue_address`   string
    Alphanumeric (upper and lower case), special characters and whitespace.
  - `timezone`   string
    Alphanumeric (upper and lower case), special characters and whitespace.
  - `updated_at`   timestamp
    Timestamp in the following format: 2025-07-02T19:15:12.511Z
  - `created_at`   timestamp
    Timestamp in the following format: 2025-07-02T19:15:12.511Z
  - `metadata`   **object**
    Keys must only contain alphanumeric (upper and lower case), hyphens and underscores. No whitespace.
    Values can contain Alphanumeric (upper and lower case), special characters and whitespace.
  - `categories`  **array**
    - `categories.[].id` string
      A unique identifier. Alphanumeric (upper and lower case), hyphens, forward slash and underscores. No whitespace.
    - `categories.[].name` string
      Alphanumeric (upper and lower case), special characters and whitespace.

***

### Sample Payload

A sample of an event payload is below.&#x20;

:::CodeblockTabs
event

```json


{
  "resource_type": "event",
  "generated_at": "2025-01-28T04:27:07.012624Z",
  "identifiers": {
    "id": "acme/event/123"
  },
  "data": {
    "name": "Sonic Conference 2025",
    "start_time": "2024-12-25T12:00:00.000000Z",
    "end_time": "2024-12-26T12:00:00.000000Z",
    "short_description": "An awesome education event",
    "description": "For the 10th year we are running the awesome educatio...",
    "person_count_goal": 3000,
    "venue_name": "ICC Sydney",
    "venue_address": "14 Darling Dr, Sydney NSW 2000",
    "timezone": "Australia/Sydney",
    "updated_at": "2025-01-28T04:27:07.012624Z",
    "created_at": "2025-01-28T04:27:07.012624Z",
    "metadata": {
      "text": "anything",
      "selector": "option2",
      "predefined": "predefinedValue"
    },
    "categories": [
      {
        "id": "acme/category/1231",
        "name": "Delegate"
      },
      {
        "id": "acme/category/1232",
        "name": "VIP"
      },
      {
        "id": "acme/category/1233",
        "name": "Crew"
      },
      {
        "id": "acme/category/1234",
        "name": "Jomablue Support"
      }
    ]
  }
}

```
:::





## Triggering an Event Payload

An example of how to trigger this payload:

1. Log in to your instance of Jomablue
2. Select an event
3. Navigate to (Event) Settings
4. Make a change to the Event Name or Venue address, then press Save

###

