INFO: Custom Web Triggers (ANWS)

posted 21 Mar 2018, 08:02 by Mobile Onboard System Admin   [ updated 22 Mar 2018, 03:07 ]
Custom Web Triggers are part of our Automatic Notification to Web Services (ANWS) platform.  These allow us to send data to your server via HTTP whenever something happens, such as a user registration, or ticket sale.  We are able to format this and populate with field values to your requirements when you are subscribed to our Enterprise Platform.

When an action happens, such a user registration, a request will be added to a queue on our system which will then send a trigger to your server in due course.  This normally happens within a couple of seconds.

So that we know that the request has been successful, we will expect your server to respond with an HTTP 200 OK status code.  The server will not process responses such as 302 Redirects.  In the event of a server error at your end, the request will be discarded, and you will not receive the data.  We do, however, log failures within our system, and we may implement retries in the future.

Requests can be made using either the POST or GET method, and this configured as part of your Enterprise instance profile.  Our platform will take care of formatting and encoding where required.

Available Field Mappings

User Registration Post

Field NameOur TokenData TypeDescription
Registration Date     %RDT% Date/Time Date and time the user registered for an account
First Name %FN% Text First name of the user
Last Name %LN% Text Last name of the user
Address #1 %A1% Text User's address line 1
Address #2 %A2% Text User's address line 2
Address #3 %A3% Text User's address line 3
Address #4 %A4% Text User's address line 4
City %CY% Text User's address city
County / State %ST% Text User's address county
Post Code %PC% Text User's address post code
User ID %UID% Number Internal unique ID for the user
Username %UN% Text User's login name
Email Address %EM% Text User's email address
Mobile Number %MOB% Number User's mobile number (international format) 

Example Post Format
https://mywebservice.com/user/?fname=%FN%&lname=%LN%&user=%UN%&id=%UID%

The token placeholders will be replaced with the appropriate values dynamically before sending the request to your server.


Transaction Post

Field NameOur TokenData TypeDescription
Transaction Time %TDT% Date/Time Date and time of the transaction
User ID %UID% Number Internal ID for the user
Mobile Number %MOB% Number User's mobile number (international format)
Email Address %EM% Text User's email address
Retailer Name %RNAM% Text Retailer/Vendor's name
Transaction ID %TID% Text Unique ID/reference for the transaction
Ticket Type ID %TTYP% Number Ticket type purchased
Ticket Name %TNAM% Text Display name / description of the ticket
Ticket Serial Number %TSN% Text Serial number(s) of the issued ticket(s)
Ticket Price %TPR% Number Face value of the ticket
Discounts Applied %TDIS% Number Any discount applied to the transaction
Amount Paid %TAMT% Number Total amount paid for the transaction
Voucher Code Used %VCD% Text Voucher code applied, where applicable
Ticket Start Date %TST% Date/Time Start date of the ticket, where applicable.  Empty if not specified.
Ticket Expiry Date %TEX% Date/Time Expiry date of the ticket, where applicable.  Empty if ticket is not   activated.

Example Post Format
https://mywebservice.com/purchase/?uid=%UID%&type=%TTYP%&transid=%TID%

The token placeholders will be replaced with the appropriate values dynamically before sending the request to your server.