Webhooks Events

Loyalty Activity Events

Whenever a payment for a registered customer occurs for a specific location, Tyro Connect notifies you via the webhook.

The types of Loyalty Activity events are:

Loyalty Event Description
NEW_LOYALTY_ACTIVITY Indicates that a registered member has made a payment.

Sample Payment Event

Copy
Copied
{
  "type": "NEW_LOYALTY_ACTIVITY",
  "data": {
    "id": "2688fcf2-44dd-4c72-88ac-79d0910f2933",
    "uri": "https://api.tyro.com/connect/loyalty/activities/2688fcf2-44dd-4c72-88ac-79d0910f2933",
    "resource": "loyalty/activities"
  }
}

Registered Card Events

Whenever a registered customer uses a new card for the first time, Tyro Connect notifies you via the webhook.

The types of Registered Card events are:

Loyalty Event Description
NEW_REGISTERED_CARD Indicates that a registered member has added a card.

Sample Registered Card Event

Copy
Copied
{
  "type": "NEW_REGISTERED_CARD",
  "data": {
    "id": "2688fcf2-44dd-4c72-88ac-79d0910f2933",
    "uri": "https://api.tyro.com/connect/loyalty/registered-cards/2688fcf2-44dd-4c72-88ac-79d0910f2933",
    "resource": "loyalty/registered-cards"
  }
}
Registering Webhooks

For information on how to register for webhooks and how to interpret the webhook message. Documentation can be found here: Webhooks

Copyright © Tyro Payments 2019-2024. All right reserved.