Passkey Callback Service
The RegLink API includes an optional callback service or webhook mechanism that allows Cvent Passkey to send a business event-driven message to a third-party application indicating when a reservation occurs, is modified, or cancelled within the Passkey platform. Cvent Passkey refers to this message as a “Callback.”
Callbacks for each reservation action (create, update, or cancel) may activate separately, allowing any combination of the three to function as needed. They can include attendee and event-specific IDs so the message can reach the external system receiving the Callback. They may trigger a variety of actions based on business logic within the external system.
Callbacks often function as a mechanism allowing a third-party system to store the Cvent Passkey housing acknowledgment number (confirmation number), which then provides attendees with a URL they can use to change their reservation or trigger a variety of attendee-specific campaigns based on the data returned in the Callback.
Cvent Passkey supports storing default callback URLs at the partner level, which can then automatically apply to events where a partner’s integration functions. Use generic callback URLs to support events.
Cvent Passkey expects an HTTP 200 (“OK”) response on any Callback messages sent and won’t process errors or other messaging. It’s up to the third-party system to process the message and provide the customer with any needed reporting.
POST To a URL
Callback services offer straightforward POST to a URL APIs. These URLs always contain all available data, and the receiving system processes the provided data. All Callback messages function asynchronously, meaning that unless a connection issue occurs or Cvent Passkey doesn’t receive an HTTP 200 response, any other response from the external system gets discarded.
Example of header information for this call:
POST ?r=323F2VKJ HTTP/1.1
User-Agent: Profile/MIDP-1.0 Configuration/CLDC-1.0
Content-Language: en-US
Content-Type: application/x-www-form-URLencoded
Host: uat-manage.passkey.com
Accept: text/html, image/gif, image/jpeg, *; q=.2, */*; q=.2
Connection: keep-alive
Content-Length: 0
X-Forwarded-For: 82.209.214.162Event planners enter callback URLs into the Cvent Passkey UI at the event level. An event planner must turn on callbacks in their event to activate them.
A Callback entry appears in the following format:
http://www.myreg.com/newres.asp?eventid=[[eventID]]&extacknum=[[extAckNumber]]&bridge=[[bridgeID]]&resacknum=[[resAckNum]]&status=[[resStatus]]The resulting URL generated when an applicable callback triggers appears in this format:
http://www.myreg.com/newres.asp?eventid=146021&extacknum=48943548&bridge=3233XNZ2-G582&resacknum=328T24NB&status=0Callback Service Tags
The following Callback Service tags include:
| Tag | Description |
|---|---|
| [[eventID]] | The unique Event ID for the Event that associates with the attendee record. This tag can improve processing performance within the target system and allow for a generic callback URL to support event integrations. |
| [[bridgeID]] | The unique identifier assigned by Cvent Passkey when attendee-specific information reaches a third-party application using the Reservation Request API. The API response returns it. |
| [[extAckNumber]] | An attendee-specific identifier assigned by an external system. This tag goes to Passkey in the “sourceID” field of the Reservation Request API. |
| [[resAckNum]] | The reservation acknowledgement (confirmation) number for the housing reservation in Cvent Passkey. |
| [[masterResAckNum]] | The reservation primary acknowledgement number applies to room list reservations or Group Booking created in Cvent Passkey. The same number applies to all reservations created within a single room list. |
| [[hotelConfNumber]] | The confirmation number for the reservation in the hotel’s Property Management System - only available once reservations begin to transfer to the hotel. |
| [[resStatus]] | The status of the reservation in Cvent Passkey: “0” (New), “1” (Cancelled), “2” (Modified), “3” (Modified and Cancelled), “5” (No Show (NS), “7” (No Show (NS), “8” (Waitlist/Pending) |
| [[lastName]] | The last name of the primary attendee on the reservation. |
| [[ResContactPhone]] | The phone number of the primary attendee on the reservation. |
Read more on activating callbacks.
Accessing Existing Reservations
The URL to view, change, or cancel an existing reservation reaches the guest via a Passkey email confirmation when booking the room.
A URL to access the reservation can also appear in the GetReservation API response.