Events

Overview

Event	Description
`newsletter_subscription.created`	Newsletter subscription was created
`newsletter_subscription.updated`	Newsletter subscription topics changed or was confirmed
`newsletter_subscription.deleted`	Newsletter subscription was deleted / unsubscribed
`topic.deleted`	Newsletter subscription topic was deleted
`user.created`	User was created
`user.updated`	User was updated
`user.deleted`	User was deleted
`subscription.created`	Subscription was created
`subscription.updated`	Subscription was updated
`subscription.deleted`	Subscription was deleted

Payload Reference

newsletter_subscription.created

{
  "event_type": "newsletter_subscription.created",
  "occured_at": "2021-09-22T16:05:20.486Z",
  "event_id": "f71970b6-d162-4ed2-9910-c8b7f48106ab",
  "newsletter_subscription": {
    "id": 43,
    "email": "[email protected]",
    "topics": ['club_news', 'player_news']
  }
}

newsletter_subscription.updated

{
  "event_type": "newsletter_subscription.updated",
  "occured_at": "2021-09-22T16:05:20.486Z",
  "event_id": "f71970b6-d162-4ed2-9910-c8b7f48106ab",
  "newsletter_subscription": {
    "id": 43,
    "email": "[email protected]",
    "topics": ['club_news', 'player_news']
  }
}

newsletter_subscription.deleted

{
  "event_type": "newsletter_subscription.deleted",
  "occured_at": "2021-09-22T16:05:20.486Z",
  "event_id": "f71970b6-d162-4ed2-9910-c8b7f48106ab",
  "newsletter_subscription": {
    "id": 43,
    "email": "[email protected]",
  }
}

Topic

topic.deleted

 {
    "event_type": "topic.deleted",
    "occured_at": "2021-09-22T16:05:20.486Z",
    "event_id": "f71970b6-d162-4ed2-9910-c8b7f48106ab",
    "topic": { "topic": 'player_news' }
  }

User

user.created

{
  "event_type": "user.created",
  "user": {
    "first_name": null,
    "last_name": null,
    "email": "[email protected]",
    "created_at": "2021-05-28T13:13:06.361Z",
    "updated_at": "2021-06-01T09:40:27.779Z",
    "confirmed_at": "2021-06-01T09:40:27.779Z",
    "salutation": null,
    "gender": null,
    "phone_number": null,
    "date_of_birth": null,
    "company_name": null,
    "address_line_1": null,
    "address_line_2": null,
    "city": null,
    "postal_code": null,
    "country_code": null,
    "unidy_id": "eb7a4199-de25-515a-991e-2e721b24728e"
  },
  "occured_at": "2021-06-01T09:44:17.073Z",
  "event_id": "b05a6dcd-472f-4930-ab0b-836f4435fa62"
}

user.updated

{
  "event_type": "user.updated",
  "user": {
    "first_name": null,
    "last_name": null,
    "email": "[email protected]",
    "created_at": "2021-05-28T13:13:06.361Z",
    "updated_at": "2021-06-01T09:40:27.779Z",
    "confirmed_at": "2021-06-01T09:40:27.779Z",
    "salutation": null,
    "gender": null,
    "phone_number": null,
    "date_of_birth": null,
    "company_name": null,
    "address_line_1": null,
    "address_line_2": null,
    "city": null,
    "postal_code": null,
    "country_code": null,
    "unidy_id": "eb7a4199-de25-515a-991e-2e721b24728e"
  },
  "occured_at": "2021-06-01T09:44:17.073Z",
  "event_id": "b05a6dcd-472f-4930-ab0b-836f4435fa62"
}

user.deleted

{
  "event_type": "user.updated",
  "user": {
    "first_name": null,
    "last_name": null,
    "email": "[email protected]",
    "created_at": "2021-05-28T13:13:06.361Z",
    "updated_at": "2021-06-01T09:40:27.779Z",
    "confirmed_at": "2021-06-01T09:40:27.779Z",
    "salutation": null,
    "gender": null,
    "phone_number": null,
    "date_of_birth": null,
    "company_name": null,
    "address_line_1": null,
    "address_line_2": null,
    "city": null,
    "postal_code": null,
    "country_code": null,
    "unidy_id": "eb7a4199-de25-515a-991e-2e721b24728e"
  },
  "occured_at": "2021-06-01T09:44:17.073Z",
  "event_id": "b05a6dcd-472f-4930-ab0b-836f4435fa62"
}

Custom Attributes

If you defined custom attributes for your users, they will be injected into the regular user data structure like this:

{
  "event_type": "user.updated",
  "user": {
    "membership_number": '12345aaa',
    "vip_user": true,
    "birth_year": 2000,
    "description": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.",
    "first_name": null,
    "last_name": null,
    "email": "[email protected]",
    "created_at": "2021-05-28T13:13:06.361Z",
    "updated_at": "2021-06-01T09:40:27.779Z",
    "confirmed_at": "2021-06-01T09:40:27.779Z",
    "salutation": null,
    "gender": null,
    "phone_number": null,
    "date_of_birth": null,
    "company_name": null,
    "address_line_1": null,
    "address_line_2": null,
    "city": null,
    "postal_code": null,
    "country_code": null,
    "unidy_id": "eb7a4199-de25-515a-991e-2e721b24728e"
  },
  "occured_at": "2021-06-01T09:44:17.073Z",
  "event_id": "b05a6dcd-472f-4930-ab0b-836f4435fa62"
}

Subscription

subscription.created

Content of metadata is not always present and it can vary depending on subscription.

{
  "event_type": "subscription.created",
  "occured_at": "2023-03-24T10:05:21.801Z",
  "event_id": "300646f5-e14b-452a-a3cb-df9e9e1b933f",
  "subscription": {
    "id": "a2472716-9062-41e8-b002-4a0320a70fbf",
    "reference": "987654321",
    "user_id": "02f4b82d-f992-4ebf-b69c-a79422142992",
    "created_at": "2023-03-24T10:04:38.430Z",
    "updated_at": "2023-03-24T10:04:38.430Z",
    "title": "factory title",
    "text": "factory test text which descirbes the subscription",
    "ends_at": "2023-03-24T10:04:38.430Z",
    "starts_at": "2023-03-24T10:04:38.430Z",
    "price": 100.99,
    "subscription_category_id": "5ea34525-34f3-4f6e-a7c1-4c1c10342f71",
    "payment_frequency": "yearly", //daily,weekly,monthly,quarterly,six_monthly,yearly,onetime
    "payment_state": "payed", // payed,not_payed
    "state": "active", // active,inactive,passive
    "next_payment_at": "2023-03-24T10:04:38.430Z",
    "metadata": {
      "name": {
        "label": "Name",
        "value": "Max Mustermann"
      },
      "test": {
        "label": "added info",
        "value": "some additional wallet information"
      }
    },
    "wallet_export": {
      "qr_code": "2222",
      "additional_attributes": [
        "name",
        "test"
      ],
      "further_information": "Lorem ipsum dolor sit amet, https://google.de"
    }
  }
}

subscription.updated