Added
Interactions API: Support added for Event Signups type
18 days ago by Sophia Peaslee
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
| Field | Type | Requirement | Description |
|---|---|---|---|
| operation | string | required | create or update |
| type | string | required | event_signup |
| value | object | required | wrapper object around event_id, shifts, role and status |
| value.event_id | object: {id, type} | required | Identifier for event, id is the event identifier and type describes the ID namespace |
| value.shifts | array of {id, type} objects | optional | Array of one or more shift identifiers. id is the shift identifier, type describes the ID namespace |
| value.role | object {name} | optional | Role of the participant in the event |
| value.status | object {status, vendor_reference} | status is required, vendor_reference is not | Signup status at time of creation. vendor_reference is an open string field. status must map to one of the statuses listed below |
Available Statuses:
scheduledwaitlistedinvitedcompletedconfirmedcancelledno_showpartialcannot_attend

