Webhook Events
These are example payloads of all webhook event you can receive from Unidy.
User
user.created
{
"event_type": "user.created",
"user": {
"first_name": null,
"last_name": null,
"email": "admin@example.com",
"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"
},
"occurred_at": "2021-06-01T09:44:17.073Z",
"occured_at": "2021-06-01T09:44:17.073Z", // OLD DEPRECATED KEY, WILL BE REMOVED
"event_id": "b05a6dcd-472f-4930-ab0b-836f4435fa62"
}user.updated
{
"event_type": "user.updated",
"user": {
"first_name": null,
"last_name": null,
"email": "admin@example.com",
"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"
},
"occurred_at": "2021-06-01T09:44:17.073Z",
"occured_at": "2021-06-01T09:44:17.073Z", // OLD DEPRECATED KEY, WILL BE REMOVED
"event_id": "b05a6dcd-472f-4930-ab0b-836f4435fa62"
}user.deleted
{
"event_type": "user.updated",
"user": {
"first_name": null,
"last_name": null,
"email": "admin@example.com",
"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"
},
"occurred_at": "2021-06-01T09:44:17.073Z",
"occured_at": "2021-06-01T09:44:17.073Z", // OLD DEPRECATED KEY, WILL BE REMOVED
"event_id": "b05a6dcd-472f-4930-ab0b-836f4435fa62"
}Newsletter Subscription
newsletter_subscription.created
{
"event_type": "newsletter_subscription.created",
"occurred_at": "2021-09-22T16:05:20.486Z",
"occured_at": "2021-09-22T16:05:20.486Z", // OLD DEPRECATED KEY, WILL BE REMOVED
"event_id": "f71970b6-d162-4ed2-9910-c8b7f48106ab",
"newsletter_subscription": {
"id": 43,
"email": "admin@example.com",
"topics": ["club_news", "player_news"], // OLD DEPRECATED KEY, WILL BE REMOVED
"preferences": ["club_news", "player_news"],
"internal_name": "default_newsletter",
"confirmed_at": "2021-09-22T16:05:20.486Z",
"preference_token": "ihg3nJfrE6M572TEpbUisZ3G"
}
}newsletter_subscription.updated
{
"event_type": "newsletter_subscription.updated",
"occurred_at": "2021-09-22T16:05:20.486Z",
"occured_at": "2021-09-22T16:05:20.486Z", // OLD DEPRECATED KEY, WILL BE REMOVED
"event_id": "f71970b6-d162-4ed2-9910-c8b7f48106ab",
"newsletter_subscription": {
"id": 43,
"email": "admin@example.com",
"topics": ["club_news", "player_news"], // OLD DEPRECATED KEY, WILL BE REMOVED
"preferences": ["club_news", "player_news"],
"internal_name": "default_newsletter",
"confirmed_at": "2021-09-22T16:05:20.486Z",
"preference_token": "ihg3nJfrE6M572TEpbUisZ3G"
}
}newsletter_subscription.deleted
{
"event_type": "newsletter_subscription.deleted",
"occurred_at": "2021-09-22T16:05:20.486Z",
"occured_at": "2021-09-22T16:05:20.486Z", // OLD DEPRECATED KEY, WILL BE REMOVED
"event_id": "f71970b6-d162-4ed2-9910-c8b7f48106ab",
"newsletter_subscription": {
"id": 43,
"email": "admin@example.com",
"topics": ["club_news", "player_news"], // OLD DEPRECATED KEY, WILL BE REMOVED
"preferences": ["club_news", "player_news"],
"internal_name": "default_newsletter",
"confirmed_at": "2021-09-22T16:05:20.486Z",
"preference_token": "ihg3nJfrE6M572TEpbUisZ3G"
}
}Topic
topic.deleted
{
"event_type": "topic.deleted",
"occurred_at": "2021-09-22T16:05:20.486Z",
"occured_at": "2021-09-22T16:05:20.486Z", // OLD DEPRECATED KEY, WILL BE REMOVED
"event_id": "f71970b6-d162-4ed2-9910-c8b7f48106ab",
"topic": { "topic": "player_news" }
}Subscription
Content of metadata is not always present and it can vary depending on subscription.
subscription.created
{
"event_type": "subscription.created",
"occurred_at": "2023-03-24T10:05:21.801Z",
"occured_at": "2023-03-24T10:05:21.801Z", // OLD DEPRECATED KEY, WILL BE REMOVED
"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
{
"event_type": "subscription.updated",
"occurred_at": "2023-03-24T10:06:03.748Z",
"occured_at": "2023-03-24T10:06:03.748Z", // OLD DEPRECATED KEY, WILL BE REMOVED
"event_id": "811d2ed8-4ac7-4c0e-88c4-ee8d0f8041f7",
"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.deleted
{
"event_type": "subscription.deleted",
"occurred_at": "2023-03-24T10:08:36.279Z",
"occured_at": "2023-03-24T10:08:36.279Z", // OLD DEPRECATED KEY, WILL BE REMOVED
"event_id": "389b1db8-7c9a-4074-8e8f-84f7344abcd2",
"subscription": {
"id": "a2472716-9062-41e8-b002-4a0320a70fbf",
"user_id": "02f4b82d-f992-4ebf-b69c-a79422142992"
}
}Custom Attributes
If you defined custom attributes for your users, they will be injected into the regular user data.
See example
{
"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": "admin@example.com",
"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"
},
"occurred_at": "2021-06-01T09:44:17.073Z",
"occured_at": "2021-06-01T09:44:17.073Z", // OLD DEPRECATED KEY, WILL BE REMOVED
"event_id": "b05a6dcd-472f-4930-ab0b-836f4435fa62"
}Handling Update Loops
You might run in the situation, where your system is updating data in Unidy via the API and then receive the resulting webhooks. You can identify those webhooks by comparing the creator of the update. E.g.:
{
...
"source": "api",
"event_id": "470d0a20-0da3-4d5e-9da6-7bac5c230670",
"client_id": "V_6L5h7bi8sbt8z3JcQFfa2zasdfd321NGS5qIC0GN_Q",
"event_type": "user.updated",
"occurred_at": "2025-03-03T09:59:26.630Z"
}If you updated a user via API and your client ID is V_6L5h7bi8sbt8z3JcQFfa2zasdfd321NGS5qIC0GN_Q , then you can ignore this webhook, because you caused the change.
Did this answer your question?
😞
😐
🤩