• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”
You are viewing an old version of the API

Loyalty account created

EVENT loyalty.account.created

Published when a loyalty account is created.


Permissions
LOYALTY_READ
Name Description
merchant_id
string

The ID of the target merchant associated with the event.

type
string

The type of event this represents, "loyalty.account.created".

event_id
string

A unique ID for the webhook event.

created_at
string

Read only Timestamp of when the webhook event was created, in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

data
LoyaltyAccountCreatedWebhookData

Data associated with the event.

Examples

You are viewing an old version of the API
Example payload
{
  "merchant_id": "C337NFWQT2A6W",
  "type": "loyalty.account.created",
  "event_id": "875f2038-6015-492e-9f29-d040b3809e49",
  "created_at": "2020-05-13T01:41:35.157Z",
  "data": {
    "type": "loyalty",
    "id": "ba2f8ab6-e131-46d9-9882-17714404eb49",
    "object": {
      "loyalty_account": {
        "id": "ba2f8ab6-e131-46d9-9882-17714404eb49",
        "program_id": "5216e8b2-d43e-41e2-9ed8-eccf3e892aef",
        "balance": 0,
        "lifetime_points": 0,
        "mapping": {
          "created_at": "2020-05-13T01:41:34Z",
          "id": "664c22ba-9460-45a5-8917-381ae72dcfdc",
          "phone_number": "+14155551234"
        },
        "created_at": "2020-05-13T01:41:34Z",
        "updated_at": "2020-05-13T01:41:34Z"
      }
    }
  }
}