Cohort Webhook Event Types
This is the list of event types that we currently send.
For guidance on how to listen to these events, take a look at Svix's guide to consuming webhooks.
challenge
object
The challenge the challenge step belongs to
3 Items
challengeStep
object
The challenge step that became available
2 Items
user
object
The user for which the step became available
3 Items
Example
JSON
{
"challenge": {
"id": "131a4d18-aad0-4277-a932-c3745d8375ef",
"name": {},
"optInCta": {}
},
"challengeStep": {
"id": "b276d64b-ff87-4ac7-9425-572b63edb6db",
"title": {}
},
"user": {
"email": "some string",
"id": "15a7db23-7429-49c8-8479-dab8fba566ea",
"lang": [
"string",
"null"
]
}
}eventTime
string
(date-time)
eventType
string
const
properties
object
2 Items
resources
object
1 Items
user
object
3 Items
Example
JSON
{
"eventTime": "2025-12-17T01:24:41.313Z",
"eventType": "cohort.app.connected",
"properties": {
"appId": "some string",
"connectionId": "13e2cb70-4606-4296-8653-2e1413e21b9a"
},
"resources": {
"app": {
"id": "some string",
"name": "some string"
}
},
"user": {
"email": "some string",
"id": "dd44f5b0-44db-4b02-be81-7dbbdaf0fc1f",
"lang": [
"string",
"null"
]
}
}eventTime
string
(date-time)
eventType
string
const
properties
object
2 Items
resources
object
1 Items
user
object
3 Items
Example
JSON
{
"eventTime": "2025-12-17T01:24:41.333Z",
"eventType": "cohort.app.disconnected",
"properties": {
"appId": "some string",
"connectionId": "7b6b8f45-b09f-48d1-8696-17f07a343a7e"
},
"resources": {
"app": {
"id": "some string",
"name": "some string"
}
},
"user": {
"email": "some string",
"id": "4a1c78f0-01e4-4b77-8085-ac66fb24fb04",
"lang": [
"string",
"null"
]
}
}eventTime
string
(date-time)
eventType
string
const
properties
object
2 Items
resources
object
2 Items
user
object
3 Items
Example
JSON
{
"eventTime": "2025-12-17T01:24:41.346Z",
"eventType": "cohort.badge.gained",
"properties": {
"badgeId": "some string",
"cohortId": "71fd378b-d14d-4fcd-9b9d-0f2c2acc591b"
},
"resources": {
"badge": {
"id": "0bf719c8-d373-4350-8704-b1373f28c1ff",
"name": "some string"
},
"cohort": {
"id": "9aa37f39-0e0a-4489-b302-f4b18a39bbf1",
"name": {}
}
},
"user": {
"email": "some string",
"id": "1abaa0db-8663-429d-b89b-018adf414d30",
"lang": [
"string",
"null"
]
}
}eventTime
string
(date-time)
eventType
string
const
properties
object
3 Items
resources
object
2 Items
user
object
3 Items
Example
JSON
{
"eventTime": "2025-12-17T01:24:41.358Z",
"eventType": "cohort.badge.lost",
"properties": {
"badgeId": "some string",
"cohortId": "88814265-8e71-4c16-8e15-9a55ce42ade9",
"resourceDeleted": true
},
"resources": {
"badge": {
"id": "bcee21aa-fb2d-453f-a886-d5468847539c",
"name": "some string"
},
"cohort": {
"id": "b788b7a6-8b55-423a-805a-63fce28a834e",
"name": {}
}
},
"user": {
"email": "some string",
"id": "7dbc62f0-6cae-477b-a104-2eacf201bca1",
"lang": [
"string",
"null"
]
}
}eventTime
string
(date-time)
eventType
string
const
properties
object
2 Items
resources
object
1 Items
user
object
3 Items
Example
JSON
{
"eventTime": "2025-12-17T01:24:41.371Z",
"eventType": "cohort.challenge.completed",
"properties": {
"campaignId": "723b5ef0-367f-4d4d-8916-e3e8c5a826d2",
"challengeParticipationId": "e7d74151-3c48-45f8-9b4a-2356ddad0fd0"
},
"resources": {
"campaign": {
"id": "dc2a66d5-557a-4af9-9b90-5de68ba8ae8b",
"name": "some string",
"slug": "some string"
}
},
"user": {
"email": "some string",
"id": "d59c2fab-ee8b-4023-9833-5af6c7c44c25",
"lang": [
"string",
"null"
]
}
}eventTime
string
(date-time)
eventType
string
const
properties
object
2 Items
resources
object
1 Items
user
object
3 Items
Example
JSON
{
"eventTime": "2025-12-17T01:24:41.384Z",
"eventType": "cohort.challenge.left",
"properties": {
"campaignId": "201a26e8-b875-4d24-a1dc-f403090031b3",
"resourceDeleted": true
},
"resources": {
"campaign": {
"id": "acddcfa7-1776-4f6b-9ecd-7f8df551c3fa",
"name": "some string",
"slug": "some string"
}
},
"user": {
"email": "some string",
"id": "20154d30-0f3a-47d2-8033-293ffcfc563b",
"lang": [
"string",
"null"
]
}
}eventTime
string
(date-time)
eventType
string
const
properties
object
1 Items
resources
object
1 Items
user
object
3 Items
Example
JSON
{
"eventTime": "2025-12-17T01:24:41.395Z",
"eventType": "cohort.challenge.new-challenge-available",
"properties": {
"campaignId": "7db0aaa9-1281-416c-8e0a-ce1421885ffb"
},
"resources": {
"campaign": {
"id": "eb1d3263-8d59-4dcd-8360-7377b5af84ef",
"name": "some string",
"slug": "some string"
}
},
"user": {
"email": "some string",
"id": "71b2e4a7-ea47-40c2-bff3-d2a29d049f1c",
"lang": [
"string",
"null"
]
}
}eventTime
string
(date-time)
eventType
string
const
properties
object
3 Items
resources
object
1 Items
user
object
3 Items
Example
JSON
{
"eventTime": "2025-12-17T01:24:41.406Z",
"eventType": "cohort.challenge.new-step-available",
"properties": {
"campaignId": "f9c1e59f-e85a-4454-bbe5-b7e00db4d836",
"challengeParticipationId": "7c21abbe-72ef-4aa1-ac74-0f2b7cab5b15",
"challengeStepId": "735da2a0-1025-4ae3-895d-a57a853c9330"
},
"resources": {
"campaign": {
"id": "b19229e2-d748-4322-a4c9-432e98d741ae",
"name": "some string",
"slug": "some string"
}
},
"user": {
"email": "some string",
"id": "3f1b512b-6a19-4aab-83a1-e13c004a587a",
"lang": [
"string",
"null"
]
}
}eventTime
string
(date-time)
eventType
string
const
properties
object
2 Items
resources
object
1 Items
user
object
3 Items
Example
JSON
{
"eventTime": "2025-12-17T01:24:41.419Z",
"eventType": "cohort.challenge.opted-in",
"properties": {
"campaignId": "1be2eb9f-da40-4bcb-b447-b70c1ff5275d",
"challengeParticipationId": "4220d211-88e3-4c8d-941e-e549ff549c2f"
},
"resources": {
"campaign": {
"id": "5cd8ff54-80f2-4da3-9f26-e8e9f3f1f55e",
"name": "some string",
"slug": "some string"
}
},
"user": {
"email": "some string",
"id": "4435eb93-ee7d-45d9-8398-aa8859f156fe",
"lang": [
"string",
"null"
]
}
}eventTime
string
(date-time)
eventType
string
const
properties
object
4 Items
resources
object
1 Items
user
object
3 Items
Example
JSON
{
"eventTime": "2025-12-17T01:24:41.430Z",
"eventType": "cohort.challenge.step-completed",
"properties": {
"campaignId": "0c8f5d64-385d-46eb-a5e5-f5881548faa8",
"challengeParticipationId": "01635553-5883-4221-b4a4-1835c528e5ff",
"challengeStepCompletionId": "f004a12f-f3e2-4817-9f8e-9b9bb1569e00",
"challengeStepId": "43ec99cf-2306-4d1f-8a3b-26f58348e548"
},
"resources": {
"campaign": {
"id": "aeb1afc8-1896-47ed-ba4c-31cc0f6c39e4",
"name": "some string",
"slug": "some string"
}
},
"user": {
"email": "some string",
"id": "2a3e87f1-0e1b-4608-8a8d-83d6faca96d2",
"lang": [
"string",
"null"
]
}
}eventTime
string
(date-time)
eventType
string
const
properties
object
1 Items
resources
object
1 Items
user
object
3 Items
Example
JSON
{
"eventTime": "2025-12-17T01:24:41.442Z",
"eventType": "cohort.cohort.joined",
"properties": {
"cohortId": "190068e8-cdcb-4d02-a914-48cc9873cd3d"
},
"resources": {
"cohort": {
"id": "684e32ca-1c77-468b-ac51-ea4991beb72e",
"name": "some string"
}
},
"user": {
"email": "some string",
"id": "8432ddaf-55ae-48da-bee3-acb268d4b758",
"lang": [
"string",
"null"
]
}
}eventTime
string
(date-time)
eventType
string
const
properties
object
1 Items
resources
object
1 Items
user
object
3 Items
Example
JSON
{
"eventTime": "2025-12-17T01:24:41.454Z",
"eventType": "cohort.cohort.left",
"properties": {
"cohortId": "dd6d62cf-68a4-4138-a6cf-0ae7960b4183"
},
"resources": {
"cohort": {
"id": "34a41dbc-1c1d-4a03-a57a-6faa94522a61",
"name": "some string"
}
},
"user": {
"email": "some string",
"id": "4e254155-339b-4658-b5d1-6690eb9b1c49",
"lang": [
"string",
"null"
]
}
}eventTime
string
(date-time)
eventType
string
const
properties
object
3 Items
resources
object
2 Items
user
object
3 Items
Example
JSON
{
"eventTime": "2025-12-17T01:24:41.466Z",
"eventType": "cohort.digital-asset.deleted",
"properties": {
"collectionId": "39c25780-e574-4b0e-b5c4-8af32a22e61c",
"digitalAssetId": "f86d1bef-f234-4fb2-9bf4-c5c539693f32",
"ownershipId": "84c50e41-3414-4cea-81a4-5be6e810e419"
},
"resources": {
"collection": {
"id": "932f81f4-6f60-4cad-a9e6-b4b8f3ce8df0",
"metadata": {},
"name": "some string"
},
"digitalAsset": {
"animationUrl": {},
"id": "6ff08883-a9ee-4c23-be15-1ae32db1c566",
"imageUrl": "uri",
"name": {},
"tokenId": {}
}
},
"user": {
"email": "some string",
"id": "699ced3b-e417-4b8d-aecf-d34b6e3c9cd3",
"lang": [
"string",
"null"
]
}
}eventTime
string
(date-time)
eventType
string
const
properties
object
3 Items
resources
object
2 Items
user
object
3 Items
Example
JSON
{
"eventTime": "2025-12-17T01:24:41.479Z",
"eventType": "cohort.digital-asset.received",
"properties": {
"collectionId": "d9f297aa-e950-4692-a822-e7399e2f79b8",
"digitalAssetId": "795a4cd1-42bf-47b3-a88d-83bbb621a964",
"ownershipId": "8f074a34-18d2-45bc-9a47-2c755ff0dfd4"
},
"resources": {
"collection": {
"id": "bae6e4bd-e929-4b48-a894-4a1b39e7d8cf",
"metadata": {},
"name": "some string"
},
"digitalAsset": {
"animationUrl": {},
"id": "ef4eb32c-f23b-4827-bcd9-a68ba3a1036a",
"imageUrl": "uri",
"name": {},
"tokenId": {}
}
},
"user": {
"email": "some string",
"id": "1dbaefa9-3716-4c4d-8b30-273cc10beec5",
"lang": [
"string",
"null"
]
}
}eventTime
string
(date-time)
eventType
string
const
properties
object
5 Items
resources
object
1 Items
user
object
3 Items
Example
JSON
{
"eventTime": "2025-12-17T01:24:41.491Z",
"eventType": "cohort.digital-asset.transferred",
"properties": {
"collectionId": "48753297-19f2-4526-99e5-e535a097c8e1",
"digitalAssetId": "f2437b1a-1331-4e04-b7fc-b70e54050920",
"ownershipId": "aeab22b8-bffc-4b0d-8d86-020a27240a23",
"recipientAddress": "some string",
"recipientEmail": {}
},
"resources": {
"collection": {
"id": "8df7a095-e87b-4218-809f-0fceb8c6a46e",
"metadata": {},
"name": "some string"
}
},
"user": {
"email": "some string",
"id": "341ccf57-caee-4abf-9da8-bf241b1129fa",
"lang": [
"string",
"null"
]
}
}eventTime
string
(date-time)
eventType
string
const
properties
object
6 Items
resources
object
0 Items
user
object
3 Items
Example
JSON
{
"eventTime": "2025-12-17T01:24:41.503Z",
"eventType": "cohort.order.created",
"properties": {
"amount": 3.14,
"campaignId": "d5538964-a426-448a-b4be-eed5e72c4f92",
"campaignInternalName": "some string",
"currency": [
"string",
"null"
],
"orderId": "e0dad705-ebed-4cf0-b8c3-216b9e817f90",
"orderType": "some string"
},
"resources": {},
"user": {
"email": "some string",
"id": "1a360b10-779a-4d55-86ef-5b6010ec677f",
"lang": [
"string",
"null"
]
}
}eventTime
string
(date-time)
eventType
string
const
properties
object
2 Items
resources
object
1 Items
user
object
3 Items
Example
JSON
{
"eventTime": "2025-12-17T01:24:41.514Z",
"eventType": "cohort.perk.received",
"properties": {
"perkAccessId": "e1083cfc-e7f4-43b7-873b-bd09d66d6890",
"perkId": "7662b881-43fc-440c-bf12-eed0661d9ceb"
},
"resources": {
"perk": {
"id": "213feda9-10d9-405c-b49b-f73ab7469b9e",
"metadata": {},
"name": "some string"
}
},
"user": {
"email": "some string",
"id": "fb7cb63f-993a-431c-a3a0-ecd66c916bfb",
"lang": [
"string",
"null"
]
}
}eventTime
string
(date-time)
eventType
string
const
properties
object
2 Items
resources
object
1 Items
user
object
3 Items
Example
JSON
{
"eventTime": "2025-12-17T01:24:41.526Z",
"eventType": "cohort.perk.restored",
"properties": {
"perkAccessId": "a0420cc9-c074-474e-b93d-6a3457ef3e7c",
"perkId": "073b4da4-2435-4123-91a5-b96e35db62c8"
},
"resources": {
"perk": {
"id": "de07c2a5-2822-4c33-9daf-a38d62ed267c",
"metadata": {},
"name": "some string"
}
},
"user": {
"email": "some string",
"id": "faf1bcce-8e5e-480f-aa57-8294b30eccf4",
"lang": [
"string",
"null"
]
}
}eventTime
string
(date-time)
eventType
string
const
properties
object
2 Items
resources
object
1 Items
user
object
3 Items
Example
JSON
{
"eventTime": "2025-12-17T01:24:41.537Z",
"eventType": "cohort.perk.revoked",
"properties": {
"perkAccessId": "32138825-416c-487c-abed-f43ead8f64a1",
"perkId": "d201b835-d88f-4d53-ba5b-2326ded8a24b"
},
"resources": {
"perk": {
"id": "f47992f1-e56f-4d94-8f87-5dd0ba965020",
"metadata": {},
"name": "some string"
}
},
"user": {
"email": "some string",
"id": "5358e484-f6d7-4555-8d8d-13606088f103",
"lang": [
"string",
"null"
]
}
}eventTime
string
(date-time)
eventType
string
const
properties
object
5 Items
resources
object
1 Items
user
object
3 Items
Example
JSON
{
"eventTime": "2025-12-17T01:24:41.549Z",
"eventType": "cohort.perk.used",
"properties": {
"perkAccessId": "db49b395-7451-48c2-8d8f-16ba88539d37",
"perkId": "0eba1116-feba-4bb7-adea-18672553e4bd",
"perkIntegrationId": [
"string",
"null"
],
"perkMetadata": {},
"perkUsageData": {}
},
"resources": {
"perk": {
"id": "61222830-4f36-4701-9144-28756ec637e0",
"metadata": {},
"name": "some string"
}
},
"user": {
"email": "some string",
"id": "7097697e-52da-4122-a828-ff045042a95b",
"lang": [
"string",
"null"
]
}
}eventTime
string
(date-time)
eventType
string
const
properties
object
1 Items
resources
object
0 Items
user
object
3 Items
Example
JSON
{
"eventTime": "2025-12-17T01:24:41.570Z",
"eventType": "cohort.user.created",
"properties": {
"memberHandle": "some string"
},
"resources": {},
"user": {
"email": "some string",
"id": "9df75d17-d213-4aa2-983e-050ee36164d5",
"lang": [
"string",
"null"
]
}
}eventTime
string
(date-time)
eventType
string
const
properties
object
0 Items
resources
object
0 Items
user
object
3 Items
Example
JSON
{
"eventTime": "2025-12-17T01:24:41.594Z",
"eventType": "cohort.user.deleted",
"properties": {},
"resources": {},
"user": {
"email": "some string",
"id": "73244281-2007-424e-8c65-2065e5afddfc",
"lang": [
"string",
"null"
]
}
}eventTime
string
(date-time)
eventType
string
const
properties
object
1 Items
resources
object
0 Items
user
object
3 Items
Example
JSON
{
"eventTime": "2025-12-17T01:24:41.647Z",
"eventType": "cohort.user.username-changed",
"properties": {
"memberHandle": "some string"
},
"resources": {},
"user": {
"email": "some string",
"id": "8b11461c-30e4-4b1c-994e-3282d1a5730b",
"lang": [
"string",
"null"
]
}
}eventTime
string
(date-time)
eventType
string
const
properties
object
1 Items
resources
object
0 Items
user
object
3 Items
Example
JSON
{
"eventTime": "2025-12-17T01:24:41.673Z",
"eventType": "cohort.user.xps-visited",
"properties": {
"sessionId": "some string"
},
"resources": {},
"user": {
"email": "some string",
"id": "c18216cd-424b-467a-9af7-d939873bed0e",
"lang": [
"string",
"null"
]
}
}digitalAssetAnimationUrl
anyOf
The URL of the animation of the digital asset (if video)
digitalAssetCollectionId
string
(uuid)
The ID of the campaign that the digital asset was created for
digitalAssetCollectionName
object
A mapping of locale to string. Example: {en: 'Hello', fr: 'Bonjour'}
0 Items
digitalAssetId
string
(uuid)
The ID of the digital asset that was created
digitalAssetImageUrl
string
(uri)
The URL of the visual of the digital asset
tokenId
anyOf
The token ID of the digital asset that was created on the smart contract
user
object
The user that received the digital asset
2 Items
Example
JSON
{
"digitalAssetAnimationUrl": {},
"digitalAssetCollectionId": "d16adee1-08be-4b92-b0e4-3b40e900a117",
"digitalAssetCollectionName": {},
"digitalAssetId": "4cd31277-82c4-4234-91fe-fa01f3667a0f",
"digitalAssetImageUrl": "uri",
"tokenId": {},
"user": {
"email": "some string",
"id": "95ce8f17-e75d-4872-a26a-cd776d6317bd"
}
}digitalAssetAnimationUrl
anyOf
The URL of the animation of the digital asset (if video)
digitalAssetCollectionId
string
(uuid)
The ID of the campaign that the digital asset was created for
digitalAssetCollectionName
object
A mapping of locale to string. Example: {en: 'Hello', fr: 'Bonjour'}
0 Items
digitalAssetId
string
(uuid)
The ID of the digital asset that was created
digitalAssetImageUrl
string
(uri)
The URL of the visual of the digital asset
from
object
The user that sent the digital asset
3 Items
network
string
The blockchain on which the digital asset is
smartContractAddress
string
The address of the smart contract of the digital asset
to
object
The user that received the digital asset
3 Items
tokenId
anyOf
The token ID of the digital asset
Example
JSON
{
"digitalAssetAnimationUrl": {},
"digitalAssetCollectionId": "038ff06e-8ec5-4c45-8330-b3d817b2d28f",
"digitalAssetCollectionName": {},
"digitalAssetId": "56d765dd-ea1a-4170-b8d6-d1911a59f137",
"digitalAssetImageUrl": "uri",
"from": {
"address": "some string",
"email": {},
"id": {}
},
"network": "polygon",
"smartContractAddress": "some string",
"to": {
"address": "some string",
"email": {},
"id": {}
},
"tokenId": {}
}eventTime
string
(date-time)
eventType
string
const
properties
object
10 Items
resources
object
0 Items
user
object
3 Items
Example
JSON
{
"eventTime": "2025-12-17T01:24:41.898Z",
"eventType": "garmin-connect.activity.created",
"properties": {
"activityId": 3.14,
"activityName": "some string",
"activityType": "RUNNING",
"averageSpeedInMetersPerSecond": 3.14,
"distanceInMeters": 3.14,
"durationInSeconds": 3.14,
"startTimeInSeconds": 3.14,
"summaryId": "some string",
"totalElevationGainInMeters": 3.14,
"userId": "some string"
},
"resources": {},
"user": {
"email": "some string",
"id": "81925a1f-5c33-4322-8733-22a56a6d1f0c",
"lang": [
"string",
"null"
]
}
}createdAt
string
(date-time)
The time at which the perk access was created
perk
object
The perk that the user got access to
5 Items
user
object
The user who got access to the perk
3 Items
Example
JSON
{
"createdAt": "2025-12-17T01:24:41.912Z",
"perk": {
"id": "39b62180-6718-426a-b73b-95bb8301692b",
"integration": {},
"internalName": "some string",
"metadata": {},
"name": {}
},
"user": {
"email": "some string",
"id": "e2d6141f-06ad-4a3d-b585-a950c1a06b39",
"lang": [
"string",
"null"
]
}
}data
anyOf
OptionalThe data relative to the usage of the perk
integration
anyOf
The integration configured for this perk, if any
metadata
object
The custom metadata of the perk
0 Items
perkApp
string
null
The app used to create this perk, if any
perkId
string
(uuid)
The ID of the perk
usedAt
string
(date-time)
The date at which the perk was used
user
object
The user that used the perk
2 Items
Example
JSON
{
"data": {},
"integration": {},
"metadata": {},
"perkApp": [
"string",
"null"
],
"perkId": "0510b559-bfc3-4b2a-963a-3d79d8df4346",
"usedAt": "2025-12-17T01:24:41.923Z",
"user": {
"email": "some string",
"id": "708d185b-5adb-46c3-a1dd-89b28534c0cc"
}
}