Attendance Payload

This document describes the Action Network webhook payload for attendances.

Attendances represent the action an activist took when they filled out and RSVPed to a specific event or bought tickets to a specific ticketed event on Action Network, or attendances POSTed to events over the API.

The attendance format is closely related to the record attendance helper and attendance resources on the Action Network API. Please refer to that documentation for a fuller explanation of fields, format, and how they relate to other resources.

Attendances are linked to the person resource corresponding to the activist who RSVPed or bought tickets, as well as the event that was used to RSVP. Ticket purchases will not be linked to an event as ticketed events are not currently represented on the Action Network API.

Sections:

Type

Attendance events are identified by their type, which is the JSON closure that surrounds the hash in the POSTed array.

The attendance type is osdi:attendance.

Back To Top ↑

Field names and descriptions

Attendance fields:
Field Name Type Description
identifiers strings[] An array of identifiers in the format [system name]:[id]. See the general concepts document for more information about identifiers.
created_date datetime The date and time the resource was created.
modified_date datetime The date and time the resource was last modified.
status enum The status of this user's RSVP or ticket purchase. One of ["declined" "tentative" "accepted" "needs action"]. System generated, always "accepted".
tickets Tickets[] An array of hashes identifying the data on each ticket purchased by the person. Only present on ticketed event attendances.
action_network:referrer_data Referrer Data A hash of referrer data such as source code and referrer code. Action Network-only.
person Person* A hash representing person data to associate with this attendance. Contains only the fields entered by the activist when they created the attendance, not full fields on their record. See the people documentation for more information about people.
add_tags strings[] An array of strings representing tags that were added to the person's record during the attendance creation. Note: The person may have already had these tags applied to their record before taking action, and in a network these tags may not exist on parent groups. This array only represents what tags were attempted to be added to the person's record, not the actual result of those operations.
action_network:sponsor Sponsor A hash of sponsor data indicating the sponsor (if the group sponsored the action) or referrer (if the group used their referrer code to send activists to take action). Useful for determining where in a network the event originated. In the case of an event in an event campaign, the sponsor will be the sponsor of the event RSVPed to, not the event campaign. Action Network-only.
Ticket fields:
Field Name Type Description
title string The name of the ticket type that was purchased.
description string A longer description of the ticket type.
amount string The amount paid for this ticket.
currency string ISO 4217 designation of currency used to pay for this ticket.
Referrer Data fields:
Field Name Type Description
source string The source code of this attendance. Equivalent to someone taking action with the url argument ?source=[your source]. Corresponds to the sources chart in this action's manage page. Action Network-only.
referrer string The referrer code of this attendance. Equivalent to someone taking action with the url argument ?referrer=[your referrer code]. Corresponds to the referrers chart in this action's manage page. Action Network-only.
website string The website referrer for this attendance. Equivalent to someone taking action after clicking a link on the listed website. Corresponds to the websites chart in this action's manage page. Action Network-only.
Sponsor fields:
Field Name Type Description
title string The name of the sponsoring or referring group. In the case of an event in an event campaign, the sponsor will be the sponsor of the event RSVPed to, not the event campaign.
browser_url string The URL to the group's public page.
Back To Top ↑

Links

Link Name Description
self A link to this individual attendance resource. Only present if this attendances was an RSVP on an event, not if this was a ticket purchase on a ticketed event. Click here for attendance documentation.
osdi:person A link to the person who made this attendance. Click here for people documentation.
osdi:events A link to the event this attendance was left on. Note: If this attendance was created via a referral code, this link may not be accessible because your API key does not give you permission to access the event itself. Only present if this attendances was an RSVP on an event, not if this was a ticket purchase on a ticketed event. Click here for event documentation.
Back To Top ↑

Related resources

Back To Top ↑

Example

If an activist takes action on an event and your webhook's trigger matches the event, an attendance webhook payload like the below will be fired off to your server's webhook URL. The below example does not show all possible fields, though it does show an event RSVP as well as a ticketed event purchase. As noted in the webhooks documentation, only fields that were entered by the activist while taking action will be included in the payload.

Request

						
POST https://your-webhook-url.com

Header:
Content-Type: application/json


[
  {
    "osdi:attendance": {
      "created_date": "2018-11-07T19:49:26Z",
      "modified_date": "2018-11-07T19:49:26Z",
      "status": "accepted",
      "identifiers": [
        "action_network:32b6df18-014f-4e0c-b112-f1bacfc41a61"
      ],
      "person": {
        "created_date": "2018-11-07T17:56:40Z",
        "modified_date": "2018-11-07T19:46:40Z",
        "family_name": "Smith",
        "postal_addresses": [
          {
            "primary": true,
            "address_lines": [
              "1600 Pennsylvania Ave NW"
            ],
            "locality": "Washington",
            "postal_code": "20036",
            "region": "District of Columbia",
            "country": "US",
            "location": {
              "latitude": 41.2967,
              "longitude": -73.6698,
              "accuracy": "Approximate"
            }
          }
        ],  
        "email_addresses": [
          {
            "primary": true,
            "address": "jsmith@mail.com",
            "status": "subscribed"
          }
        ],
        "languages_spoken": [
          "en"
        ],
        "custom_fields": {
          "phone_number": "123.456.7890"
        }
      },
      "action_network:referrer_data": {
        "source": "facebook"
      },
      "add_tags": [
        "volunteer",
        "member"
      ],
      "_links": {
        "self": {
          "href": "https://actionnetwork.org/api/v2/events/48de2ac1-2398-41db-8d19-699e23bec035/attendances/32b6df18-014f-4e0c-b112-f1bacfc41a61"
        },
        "osdi:event": {
          "href": "https://actionnetwork.org/api/v2/events/48de2ac1-2398-41db-8d19-699e23bec035"
        },
        "osdi:person": {
          "href": "https://actionnetwork.org/api/v2/people/0df69aaf-3614-4315-b73a-088866b404e8"
        }
      }
    },
    "action_network:sponsor": {
      "title": "Progressive Action Now",
      "url": "https://actionnetwork.org/groups/progressive-action-now"
    }
  },
  {
    "osdi:attendance": {
      "created_date": "2018-11-07T19:49:26Z",
      "modified_date": "2018-11-07T19:49:26Z",
      "status": "accepted",
      "tickets": [
	    {
		  "title": "General Admission",
		  "description": "General admission for our gala dinner.",
		  "amount": "50",
		  "currency": "USD"
		},
		{
		  "title": "General Admission",
		  "description": "General admission for our gala dinner.",
		  "amount": "50",
		  "currency": "USD"
		},
		{
		  "title": "VIP Admission",
		  "description": "VIP admission for our gala dinner.",
		  "amount": "500",
		  "currency": "USD"
		}
      ],
      "identifiers": [
        "action_network:32b6df18-014f-4e0c-b112-f1bacfc41a61"
      ],
      "person": {
        "created_date": "2018-11-07T17:56:40Z",
        "modified_date": "2018-11-07T19:46:40Z",
        "family_name": "Smith",
        "postal_addresses": [
          {
            "primary": true,
            "address_lines": [
              "1600 Pennsylvania Ave NW"
            ],
            "locality": "Washington",
            "postal_code": "20036",
            "region": "District of Columbia",
            "country": "US",
            "location": {
              "latitude": 41.2967,
              "longitude": -73.6698,
              "accuracy": "Approximate"
            }
          }
        ],  
        "email_addresses": [
          {
            "primary": true,
            "address": "jsmith@mail.com",
            "status": "subscribed"
          }
        ],
        "languages_spoken": [
          "en"
        ],
        "custom_fields": {
          "phone_number": "123.456.7890"
        }
      },
      "action_network:referrer_data": {
        "source": "facebook"
      },
      "add_tags": [
        "volunteer",
        "member"
      ],
      "_links": {
        "osdi:person": {
          "href": "https://actionnetwork.org/api/v2/people/0df69aaf-3614-4315-b73a-088866b404e8"
        }
      }
    },
    "action_network:sponsor": {
      "title": "Progressive Action Now",
      "url": "https://actionnetwork.org/groups/progressive-action-now"
    }
  }
]
					
Back To Top ↑