A postback is a one time data send for each instance when a pre-set trigger has been met. Postbacks are often used to send specific information to an external partner at the time of registration. For example, sending participant information to an external vendor for one of your event's products so the vendor has a record of the transaction, along with the participant's information if any action is needed from the vendor.
1. From your event dashboard, you can enable postback request settings from the settings overview tab from the lefthand side menu by clicking on the postback request settings tab available under add-ons. Once turned on, this setting will permanently be available under your add-ons tab from the lefthand side menu.
2. Once enabled, you will be able to click on and access your postback request settings under the add-ons tab.
3. Click the green "create postback" button to begin configuring the parameters and settings of your first postback.
4. Input the following information to configure your postback:
- Postback name
- The postback name is for your purposes only
- It is only displayed within the postback settings as a way to distinguish between multiple postbacks
- Selecting postback status
- Active or inactive
- Endpoint URL
- The endpoint URL for the postback from our system
- This It can make either a GET or POST request to your desired URL
- Request method
- POST = Sending and updating new data
- GET = Retrieving data
- API Key (This is generated by default, you can enter a custom API key if needed, otherwise, leave the auto-generated API key in the field provided
5. Select your tags for your postbacks by clicking the dropdown menu under the add new tag headline. The selected tags will be the data fields that are pulled from the participant's transaction and sent to the endpoint URL provided by the third party. Tags can consist of:
- Participant personal information
- Product information
- Registration question information
6. Set your triggers for your postback. The selected triggers are what will initiate the postback once the criteria has been met by the participant during registration. Set your triggers so that a new postback will be sent once the desired action has been met.
Validating Postbacks
- Receive a POST request sent from Race Roster
- Read the authorization header from the POST request
- Decode the Base64 value after "Basic "
For example, in:Basic QVBJX0tFWQ==
you would decode the Base64 value ofQVBJX0tFWQ==
- Confirm that the decoded value matches your API key
Note
- Postbacks can be sent as JSON files which are lightweight, text-based file formats that can be opened and read through any text editor.
- Postbacks will still send if the event is in draft or demo status
- Postbacks will not send from manually adding participants to an event
Comments
0 comments