Skip to content

RSVPs

RSVPs to an event with an external system may be confirmed in our systems via the endpoints detailed below.

This requires receivesRsvpWebhooks to be set to true on the event itself, and externalUrl must be set.

Identification of attendees is done via the ID provided by your SSO backend, in combination with our unique ID for your event as provided by our system. This means that you must store the ID from our system somewhere in order to correlate our system with the external ticketing system.

If you're not using the API to enter events in our system, the event's unique ID can be found in its URL, as these follow a fixed pattern: /events/{slug}-{id}. E.g. if the event's URL is /events/international-womens-day-2024-9999, its unique ID is 9999. If the event's slug happens to end in numbers itself, the unique ID will always be the final part of the URL, if split by dashes.

Endpoints

Confirm

Confirms an attendee's RSVP, indicating that any payments have been processed and they will be attending. It accepts the following body parameters:

eventId

int required

The event's unique ID, as provided by our system.

ssoId

string | int required

The member's ID as provided by your SSO API.

Possible responses:

  • 200 RSVP confirmed
  • 404 Either the member or the event was not found.
HTTP
POST /channels/events.confirm-rsvp
Content-Type: application/json
Authorization: Channel <Api Key>
X-Channel: <Channel Identifier>

{
    "eventId": "ID as provided by our system",
    "ssoId": "ID as provided by your SSO API"
}
JSON
{
    "requestId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "status": 200
}

Unconfirm

Removes an attendee's RSVP confirmation, but does not remove them as an attendee by default. It accepts the following body parameters:

eventId

int required

The event's unique ID, as provided by our system.

ssoId

string | int required

The member's ID as provided by your SSO API.

removeRecord

boolean optional

Default: false

Whether to remove the attendee's record entirely.

Possible responses:

  • 200 RSVP unconfirmed
  • 404 Either the member or the event was not found.
HTTP
POST /channels/events.unconfirm-rsvp
Content-Type: application/json
Authorization: Channel <Api Key>
X-Channel: <Channel Identifier>

{
    "eventId": "ID as provided by our system",
    "ssoId": "ID as provided by your SSO API"
}
JSON
{
    "requestId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "status": 200
}