Added

Interactions API: Support added for Event Signups type

Event Signups type supported by Interactions API

Interactions API now supports a new optional interactions type, event_signup, in the outcomesDetailed array. Available operations on this type are create for creating a new signup and update for updating an existing one.

Event Signups are not currently supported for VAN as a destination.

Event Signup Schema:

{
  "operation": "create",
  "type": "event_signup",
  "value": {
    "event_id": {
      "id": "string",
      "type": "string"
    },
    "shifts": [
      {
        "id": "string",
        "type": "string"
      }
    ]
  },
  "role": { "name": "string"},
  "status": {
    "status": "string",
    "vendor_reference": "string"
  }
}

Field Reference

FieldTypeRequirementDescription
operationstringrequiredcreate or update
typestringrequiredevent_signup
valueobjectrequiredwrapper object around event_id, shifts, role and status
value.event_idobject: {id, type}requiredIdentifier for event, id is the event identifier and type describes the ID namespace
value.shiftsarray of {id, type} objectsoptionalArray of one or more shift identifiers. id is the shift identifier, type describes the ID namespace
value.roleobject {name}optionalRole of the participant in the event
value.statusobject {status, vendor_reference}status is required, vendor_reference is notSignup status at time of creation. vendor_reference is an open string field. status must map to one of the statuses listed below

Available Statuses:

  • scheduled
  • waitlisted
  • invited
  • completed
  • confirmed
  • cancelled
  • no_show
  • partial
  • cannot_attend