Getting Started

Categories & Roles

Every official event has a category and usually one page that has been assigned a primary performer role. You must include a category when you create an event. Role assignments, however, are optional. You can the see the list of Roles and Categories in the Official Events API Reference Documentation (Note: Your application must be added to the allow list for you to view the Reference Documentation)

App Access Token

All API requests require your app access token.

Creating

To create an official event, send a POST request to the official_events edge and include the following parameters:

This will create the event and return the event id.

Example Request and Response

  Http Method: POST
  URL: /v2.8/official_events
  Request Body:
  {
     "name": "Get Started with Ticketing",
     "description": "This is the best place to buy your first ticket",
     "access_token": "{access_token}",
     "place_id": "{place_id}",
     "cover": {
        "source":  "{hosted_image_url}",
        "offset_x": 0,
        "offset_y": 0
        },
     "category": "FAMILY_EVENT",
     "timezone": "US/Pacific",
     "start_time": "2012-03-24 17 (tel:2012032417) 17:45:12",
     "roles":{"{page_id}":"{EVENT_ROLE}"}
  }
  

  Response Body:
  {
     "id": "{id_of_the_new_event}"
  }
  

Reading

To read an official event, send a GET request to /{official_event_id}.

Example Request and Response

  Http Method: GET
  URL: /v2.8/{official_event_id}?access_token={access_token}
  

  Response Body:
  {
     "description": "This is the best place to buy your first ticket",
     "name": "Get Started with Ticketing",
     "place": {
        "name": "Facebook HQ",
        "location": {
            "city": "Menlo Park",
            "country": "United States",
            "latitude": 37.483909424364,
            "longitude": -122.1489697771,
            "state": "CA",
            "street": "1 Hacker Way",
            "zip": "94025"
         },
        "id": "{place_id}"
      },
     "start_time": "2012-03-24T17:45:12-0700",
     "id": "{event_id}"
  }
  

Updating

To update an official event, send a POST request to /{official_event_id}.

Example Request and Response

  Http Method: POST
  URL: /v2.8/{official_event_id}
  Request Body:
  {
     "name": "This is an updated name of the event",
     "access_token": "{access_token}"
  }
  

  Response Body:
  {
     "success": boolean
  }
  

Deleting

To delete an official event, send a DELETE request to /{official_event_id}.

Example Request and Response

  Http Method: DELETE
  URL: /v2.8/{official_event_id}
  Request Body:
  {
     "access_token":"{access_token}"
  }
  

  Response Body:
  {
      "success": boolean
  }
  

Merging

You can merge an official event with another by sending a POST request to /{official_event_id}/merge_into and including the target event's official event id.

Example Request and Response

  Http Method: POST
  URL: /v2.8/{official_event_id}/merge_into
  Request Body:
  {
     "access_token": "{access_token}",
     "destination_id": "{target_event_id}"
  }
  

  Response Body:
  {
     "success": boolean
  }
  

Pixel Implementation Guide

Who is this for?

Transactional partners implementing their FB integrated checkout flow must implement the Facebook Pixel. Read more about Facebook Pixel.

Implementation

Follow these steps and make sure Pixel is setup in your Ads Manager. Start adding the code snippet to your pages. At a minimum, the pixel should be enabled by traffic driven from Facebook.

Ticketing Specific Pixel Events

1. Landing on the ticket purchase page

   (fbq('track', 'ViewContent', {content_ids: ['partner_event_id']}))
           

2. Entering checkout flow

   (fbq('track', 'InitiateCheckout', {content_ids: ['partner_event_id']}))
           

3. Purchase

   (fbq('track', 'Purchase', {value:15.30, currency: 'USD', num_items: 1, {content_ids: ['partner_event_id']}})
           

Error Handling

Testing using Sample code

Want to test the waters before you begin development work ? Use this link below to test the API functionalities in your local Postman instance

You can download the Postman collection using this link: Official Events API Collection In addition to the collection download this environment file and import to your postman instance that will help running these sample code