Events

List of all events along side with the data provided.

Tours

Events related to Jimo Tours

tour.created

A member of your team created a new tour

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
experience	Experience	Tour created
user	User	User who created

Request example

{
  "event": "tour.created",
  "version": "0",
  "time": 1740125703000,
  "experience": {
    "uid": "550433b7-6b40-4f4a-a8bc-79ad2a55a847",
    "title": "Onboarding",
    "type": "TOUR",
    "state": "LIVE",
    "isDraft": true,
    "publishedAt": null,
    "createdAt": "2025-02-21T08:15:03.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "SINGLE_TIME",
    "recurrencyValue": 1
  },
  "user": {
    "uid": "17de6523-2033-4aaa-a500-d9369b611284",
    "email": "[email protected]",
    "firstName": "Sam",
    "lastName": "at Jimo"
  }
}

tour.published

A member of your team published a tour

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
experience	Experience	Tour published
user	User	User who published

Request example

{
  "event": "tour.published",
  "version": "0",
  "time": 1740127471000,
  "experience": {
    "uid": "550433b7-6b40-4f4a-a8bc-79ad2a55a847",
    "title": "Onboarding",
    "type": "TOUR",
    "state": "LIVE",
    "isDraft": false,
    "publishedAt": "2025-02-21T08:44:31.000Z",
    "createdAt": "2025-02-21T08:15:03.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "SINGLE_TIME",
    "recurrencyValue": 1
  },
  "user": {
    "uid": "17de6523-2033-4aaa-a500-d9369b611284",
    "email": "[email protected]",
    "firstName": "Sam",
    "lastName": "at Jimo"
  }
}

tour.deleted

A member of your team deleted a tour

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
experience	Experience	Tour deleted
user	User	User who deleted

Request example

{
  "event": "tour.deleted",
  "version": "0",
  "time": 1740131177000,
  "experience": {
    "uid": "550433b7-6b40-4f4a-a8bc-79ad2a55a847",
    "title": "Onboarding",
    "type": "TOUR",
    "state": "LIVE",
    "isDraft": false,
    "publishedAt": "2025-02-21T08:44:31.000Z",
    "createdAt": "2025-02-21T08:15:03.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "SINGLE_TIME",
    "recurrencyValue": 1
  },
  "user": {
    "uid": "17de6523-2033-4aaa-a500-d9369b611284",
    "email": "[email protected]",
    "firstName": "Sam",
    "lastName": "at Jimo"
  }
}

tour.status-changed

A member of your team either paused or put live a tour

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
experience	Experience	Tour updated
user	User	User who updated

Request example

{
  "event": "tour.status-changed",
  "version": "0",
  "time": 1740131839000,
  "experience": {
    "uid": "0814ae77-568d-41c0-912a-0b4c63dc03ff",
    "type": "TOUR",
    "state": "PAUSED",
    "title": "Onboarding",
    "isDraft": false,
    "createdAt": "2025-02-19T10:36:46.000Z",
    "expiresAt": null,
    "publishedAt": "2025-02-19T10:37:10.000Z",
    "triggerType": "DEFAULT",
    "recurrencyType": "EVERY_TIME",
    "recurrencyValue": 1
  },
 "user": {
    "uid": "17de6523-2033-4aaa-a500-d9369b611284",
    "email": "[email protected]",
    "lastName": "at Jimo",
    "firstName": "Sam"
  },
}

tour.started

A tour has been started by a user

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
experience	Experience	Tour started
jimer	Jimer	User who started

Request example

{
  "event": "tour.started",
  "version": "0",
  "time": 1740133655000,
  "experience": {
    "uid": "0814ae77-568d-41c0-912a-0b4c63dc03ff",
    "title": "Onboarding",
    "type": "TOUR",
    "state": "LIVE",
    "isDraft": false,
    "publishedAt": "2025-02-19T10:37:10.000Z",
    "createdAt": "2025-02-19T10:36:46.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "EVERY_TIME",
    "recurrencyValue": 1
  },
  "jimer": {
    "uid": "17dff65e-434d-4454-bb57-a1167fefbb6b",
    "identifyToken": "sam",
    "username": "Sam",
    "email": null,
    "createdAt": "2025-02-03T11:50:01.000Z",
    "lastActivityAt": "2025-02-21T10:27:35.000Z"
  }
}

tour.completed

A tour has been completed by a user

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
experience	Experience	Tour completed
jimer	Jimer	User who completed

Request example

{
  "event": "tour.completed",
  "version": "0",
  "time": 1740133769000,
  "experience": {
    "uid": "0814ae77-568d-41c0-912a-0b4c63dc03ff",
    "title": "Onboarding",
    "type": "TOUR",
    "state": "LIVE",
    "isDraft": false,
    "publishedAt": "2025-02-19T10:37:10.000Z",
    "createdAt": "2025-02-19T10:36:46.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "EVERY_TIME",
    "recurrencyValue": 1
  },
  "jimer": {
    "uid": "17dff65e-434d-4454-bb57-a1167fefbb6b",
    "identifyToken": "sam",
    "username": "Sam",
    "email": null,
    "createdAt": "2025-02-03T11:50:01.000Z",
    "lastActivityAt": "2025-02-21T10:29:28.000Z"
  }
}

tour.cta.clicked

A CTA has been clicked by a user in a tour

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
experience	Experience	Tour completed
jimer	Jimer	User who clicked
cta	CTA	CTA Clicked

Request example

{
  "event": "tour.cta.clicked",
  "version": "0",
  "time": 1740133769000,
  "experience": {
    "uid": "0814ae77-568d-41c0-912a-0b4c63dc03ff",
    "title": "Onboarding",
    "type": "TOUR",
    "state": "LIVE",
    "isDraft": false,
    "publishedAt": "2025-02-19T10:37:10.000Z",
    "createdAt": "2025-02-19T10:36:46.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "EVERY_TIME",
    "recurrencyValue": 1
  },
  "jimer": {
    "uid": "17dff65e-434d-4454-bb57-a1167fefbb6b",
    "identifyToken": "sam",
    "username": "Sam",
    "email": null,
    "createdAt": "2025-02-03T11:50:01.000Z",
    "lastActivityAt": "2025-02-21T10:29:28.000Z"
  },
  "cta": {
    "uid": "fda1491d-7675-4d72-9583-94b475ede0bb",
    "type": "PRIMARY_CTA",
    "text": "Take me there"
  }
}

Surveys

Events related to Jimo Surveys

survey.created

A member of your team created a new tour

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
experience	Experience	Survey created
user	User	User who created

Request example

{
  "event": "survey.created",
  "version": "0",
  "time": 1740135237000,
  "experience": {
    "uid": "4fdd4ff9-e695-47c3-a54d-41bf335ba0ff",
    "title": "CSAT",
    "type": "SURVEY",
    "state": "LIVE",
    "isDraft": true,
    "publishedAt": null,
    "createdAt": "2025-02-21T10:53:57.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "SINGLE_TIME",
    "recurrencyValue": 1
  },
  "user": {
    "uid": "17de6523-2033-4aaa-a500-d9369b611284",
    "email": "[email protected]",
    "firstName": "Sam",
    "lastName": "at Jimo"
  }
}

survey.published

A member of your team published a survey

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
experience	Experience	Survey published
user	User	User who published

Request example

{
  "event": "survey.published",
  "version": "0",
  "time": 1740135333000,
  "experience": {
    "uid": "4fdd4ff9-e695-47c3-a54d-41bf335ba0ff",
    "title": "CSAT",
    "type": "SURVEY",
    "state": "LIVE",
    "isDraft": false,
    "publishedAt": "2025-02-21T10:55:33.000Z",
    "createdAt": "2025-02-21T10:53:57.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "SINGLE_TIME",
    "recurrencyValue": 1
  },
  "user": {
    "uid": "17de6523-2033-4aaa-a500-d9369b611284",
    "email": "[email protected]",
    "firstName": "Sam",
    "lastName": "at Jimo"
  }
}

survey.deleted

A member of your team deleted a survey

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
experience	Experience	Survey deleted
user	User	User who deleted

Request example

{
  "event": "survey.deleted",
  "version": "0",
  "time": 1740135740000,
  "experience": {
    "uid": "4fdd4ff9-e695-47c3-a54d-41bf335ba0ff",
    "title": "CSAT",
    "type": "SURVEY",
    "state": "PAUSED",
    "isDraft": false,
    "publishedAt": "2025-02-21T10:55:33.000Z",
    "createdAt": "2025-02-21T10:53:57.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "SINGLE_TIME",
    "recurrencyValue": 1
  },
  "user": {
    "uid": "17de6523-2033-4aaa-a500-d9369b611284",
    "email": "[email protected]",
    "firstName": "Sam",
    "lastName": "at Jimo"
  }
}

survey.status-changed

A member of your team either paused or put live a survey

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
experience	Experience	Survey updated
user	User	User who updated

Request example

{
  "event": "survey.status-changed",
  "version": "0",
  "time": 1740135380000,
  "experience": {
    "uid": "4fdd4ff9-e695-47c3-a54d-41bf335ba0ff",
    "title": "CSAT",
    "type": "SURVEY",
    "state": "LIVE",
    "isDraft": false,
    "publishedAt": "2025-02-21T10:55:33.000Z",
    "createdAt": "2025-02-21T10:53:57.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "SINGLE_TIME",
    "recurrencyValue": 1
  },
  "user": {
    "uid": "17de6523-2033-4aaa-a500-d9369b611284",
    "email": "[email protected]",
    "firstName": "Sam",
    "lastName": "at Jimo"
  }
}

survey.started

A user started a survey

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
experience	Experience	Survey started
jimer	Jimer	User who started

Request example

{
  "event": "survey.started",
  "version": "0",
  "time": 1740140626000,
  "experience": {
    "uid": "69cfb25b-1e1b-4489-8fe1-13a941d8f19c",
    "title": "CSAT",
    "type": "SURVEY",
    "state": "LIVE",
    "isDraft": false,
    "publishedAt": "2025-02-21T12:23:37.000Z",
    "createdAt": "2025-02-21T12:23:22.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "SINGLE_TIME",
    "recurrencyValue": 1
  },
  "jimer": {
    "uid": "17dff65e-434d-4454-bb57-a1167fefbb6b",
    "identifyToken": "sam",
    "username": "Sam",
    "email": null,
    "createdAt": "2025-02-03T11:50:01.000Z",
    "lastActivityAt": "2025-02-21T12:22:50.000Z"
  }
}

survey.completed

A survey has been completed by a user

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
experience	Experience	Survey completed
jimer	Jimer	User who completed
survey	Survey	Survey of the user

Request example

{
  "event": "survey.completed",
  "version": "0",
  "time": 1740140782000,
  "experience": {
    "uid": "69cfb25b-1e1b-4489-8fe1-13a941d8f19c",
    "title": "CSAT",
    "type": "SURVEY",
    "state": "LIVE",
    "isDraft": false,
    "publishedAt": "2025-02-21T12:23:37.000Z",
    "createdAt": "2025-02-21T12:23:22.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "SINGLE_TIME",
    "recurrencyValue": 1
  },
  "jimer": {
    "uid": "17dff65e-434d-4454-bb57-a1167fefbb6b",
    "identifyToken": "sam",
    "username": "Sam",
    "email": null,
    "createdAt": "2025-02-03T11:50:01.000Z",
    "lastActivityAt": "2025-02-21T12:26:21.000Z"
  },
  "survey": {
    "uid": "51c368df-4e73-452a-871d-6c105b17f3a7",
    "createdAt": "2025-02-03T12:51:52.000Z"
  },
}

survey.step.answered

A survey has been completed by a user

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
experience	Experience	Survey answered
jimer	Jimer	User who answered
step	Step	Step answered by the user
survey	Survey	Survey of the user
answer	Answer	Answer of the user

Request example

{
  "event": "survey.step.answered",
  "version": "0",
  "time": 1740140781000,
  "experience": {
    "uid": "69cfb25b-1e1b-4489-8fe1-13a941d8f19c",
    "title": "CSAT",
    "type": "SURVEY",
    "state": "LIVE",
    "isDraft": false,
    "publishedAt": "2025-02-21T12:23:37.000Z",
    "createdAt": "2025-02-21T12:23:22.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "SINGLE_TIME",
    "recurrencyValue": 1
  },
  "step": {
    "uid": "772550b1-0edd-45c1-9a17-8792a13f43ef",
    "name": "Step nps 1",
    "type": "NPS",
    "indexOrder": 0
  },
  "survey": {
    "uid": "51c368df-4e73-452a-871d-6c105b17f3a7",
    "createdAt": "2025-02-03T12:51:52.000Z"
  },
  "answer": {
    "uid": "2958b624-489b-405d-836c-05aedcd33ecb",
    "value": "8"
  },
  "jimer": {
    "uid": "17dff65e-434d-4454-bb57-a1167fefbb6b",
    "identifyToken": "sam",
    "username": "Sam",
    "email": null,
    "createdAt": "2025-02-03T11:50:01.000Z",
    "lastActivityAt": "2025-02-21T12:22:50.000Z"
  }
}

Checklists

Events related to Jimo Checklists

checklist.created

A member of your team created a new checklist

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
experience	Experience	Checklist created
user	User	User who created

Request example

{
  "event": "checklist.created",
  "version": "0",
  "time": 1740141639000,
  "experience": {
    "uid": "4f0bbe2c-d6d7-455c-a1c3-09a2bdf79733",
    "title": "First steps",
    "type": "CHECKLIST",
    "state": "LIVE",
    "isDraft": true,
    "publishedAt": null,
    "createdAt": "2025-02-21T12:40:39.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "SINGLE_TIME",
    "recurrencyValue": 1
  },
  "user": {
    "uid": "17de6523-2033-4aaa-a500-d9369b611284",
    "email": "[email protected]",
    "firstName": "Sam",
    "lastName": "at Jimo"
  }
}

checklist.published

A member of your team published a checklist

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
experience	Experience	Checklist published
user	User	User who published

Request example

{
  "event": "checklist.published",
  "version": "0",
  "time": 1740141757000,
  "experience": {
    "uid": "4f0bbe2c-d6d7-455c-a1c3-09a2bdf79733",
    "title": "First steps",
    "type": "CHECKLIST",
    "state": "LIVE",
    "isDraft": false,
    "publishedAt": "2025-02-21T12:42:37.000Z",
    "createdAt": "2025-02-21T12:40:39.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "SINGLE_TIME",
    "recurrencyValue": 1
  },
  "user": {
    "uid": "17de6523-2033-4aaa-a500-d9369b611284",
    "email": "[email protected]",
    "firstName": "Sam",
    "lastName": "at Jimo"
  }
}

checklist.deleted

A member of your team deleted a checklist

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
experience	Experience	Checklist deleted
user	User	User who deleted

Request example

{
  "event": "checklist.deleted",
  "version": "0",
  "time": 1740141844000,
  "experience": {
    "uid": "4f0bbe2c-d6d7-455c-a1c3-09a2bdf79733",
    "title": "First steps",
    "type": "CHECKLIST",
    "state": "LIVE",
    "isDraft": false,
    "publishedAt": "2025-02-21T12:42:37.000Z",
    "createdAt": "2025-02-21T12:40:39.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "SINGLE_TIME",
    "recurrencyValue": 1
  },
  "user": {
    "uid": "17de6523-2033-4aaa-a500-d9369b611284",
    "email": "[email protected]",
    "firstName": "Sam",
    "lastName": "at Jimo"
  }
}

checklist.status-changed

A member of your team either paused or put live a checklist

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
experience	Experience	Checklist updated
user	User	User who updated

Request example

{
  "event": "checklist.status-changed",
  "version": "0",
  "time": 1740141992000,
  "experience": {
    "uid": "f15155ac-814b-4281-a998-a1db77979b5f",
    "title": "First steps",
    "type": "CHECKLIST",
    "state": "LIVE",
    "isDraft": false,
    "publishedAt": "2025-02-21T12:46:20.000Z",
    "createdAt": "2025-02-21T12:46:05.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "SINGLE_TIME",
    "recurrencyValue": 1
  },
  "user": {
    "uid": "17de6523-2033-4aaa-a500-d9369b611284",
    "email": "[email protected]",
    "firstName": "Sam",
    "lastName": "at Jimo"
  }
}

checklist.started

A user started a checklist

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
experience	Experience	Checklist started
jimer	Jimer	User who started

Request example

{
  "event": "checklist.started",
  "version": "0",
  "time": 1740142189000,
  "experience": {
    "uid": "f15155ac-814b-4281-a998-a1db77979b5f",
    "title": "First steps",
    "type": "CHECKLIST",
    "state": "LIVE",
    "isDraft": false,
    "publishedAt": "2025-02-21T12:46:20.000Z",
    "createdAt": "2025-02-21T12:46:05.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "SINGLE_TIME",
    "recurrencyValue": 1
  },
  "jimer": {
    "uid": "17dff65e-434d-4454-bb57-a1167fefbb6b",
    "identifyToken": "sam",
    "username": "Sam",
    "email": null,
    "createdAt": "2025-02-03T11:50:01.000Z",
    "lastActivityAt": "2025-02-21T12:49:37.000Z"
  }
}

checklist.completed

A user completed a checklist

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
experience	Experience	Checklist completed
jimer	Jimer	User who completed

Request example

{
  "event": "checklist.completed",
  "version": "0",
  "time": 1740142258000,
  "experience": {
    "uid": "f15155ac-814b-4281-a998-a1db77979b5f",
    "title": "First steps",
    "type": "CHECKLIST",
    "state": "LIVE",
    "isDraft": false,
    "publishedAt": "2025-02-21T12:46:20.000Z",
    "createdAt": "2025-02-21T12:46:05.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "SINGLE_TIME",
    "recurrencyValue": 1
  },
  "jimer": {
    "uid": "17dff65e-434d-4454-bb57-a1167fefbb6b",
    "identifyToken": "sam",
    "username": "Sam",
    "email": null,
    "createdAt": "2025-02-03T11:50:01.000Z",
    "lastActivityAt": "2025-02-21T12:50:58.000Z"
  }
}

checklist.dismissed

A user dismissed a checklist

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
experience	Experience	Checklist dismissed
jimer	Jimer	User who dismissed

Request example

{
  "event": "checklist.dismissed",
  "version": "0",
  "time": 1740142342000,
  "experience": {
    "uid": "ac5f6986-e161-4888-b44d-cd3e0c7be723",
    "title": "Copy of First steps",
    "type": "CHECKLIST",
    "state": "LIVE",
    "isDraft": false,
    "publishedAt": "2025-02-21T12:52:11.000Z",
    "createdAt": "2025-02-21T12:51:50.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "SINGLE_TIME",
    "recurrencyValue": 1
  },
  "jimer": {
    "uid": "17dff65e-434d-4454-bb57-a1167fefbb6b",
    "identifyToken": "sam",
    "username": "Sam",
    "email": null,
    "createdAt": "2025-02-03T11:50:01.000Z",
    "lastActivityAt": "2025-02-21T12:52:21.000Z"
  }

checklist.task.completed

A user completed a task of a checklist

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
experience	Experience	Checklist's task
task	Task	Task completed
jimer	Jimer	User who completed

Request example

{
  "event": "checklist.task.completed",
  "version": "0",
  "time": 1740142200000,
  "experience": {
    "uid": "f15155ac-814b-4281-a998-a1db77979b5f",
    "title": "First steps",
    "type": "CHECKLIST",
    "state": "LIVE",
    "isDraft": false,
    "publishedAt": "2025-02-21T12:46:20.000Z",
    "createdAt": "2025-02-21T12:46:05.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "SINGLE_TIME",
    "recurrencyValue": 1
  },
  "task": {
    "uid": "3a8917b4-8f7e-4a88-832e-87f92400f49b",
    "name": "Task #1"
  },
  "jimer": {
    "uid": "17dff65e-434d-4454-bb57-a1167fefbb6b",
    "identifyToken": "sam",
    "username": "Sam",
    "email": null,
    "createdAt": "2025-02-03T11:50:01.000Z",
    "lastActivityAt": "2025-02-21T12:49:37.000Z"
  }

checklist.task.skipped

A user skipped a task of a checklist

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
experience	Experience	Checklist's task
task	Task	Task skipped
jimer	Jimer	User who skipped

Request example

{
  "event": "checklist.task.skipped",
  "version": "0",
  "time": 1740142258000,
  "experience": {
    "uid": "f15155ac-814b-4281-a998-a1db77979b5f",
    "title": "First steps",
    "type": "CHECKLIST",
    "state": "LIVE",
    "isDraft": false,
    "publishedAt": "2025-02-21T12:46:20.000Z",
    "createdAt": "2025-02-21T12:46:05.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "SINGLE_TIME",
    "recurrencyValue": 1
  },
  "task": {
    "uid": "240dfe18-5883-453c-bd0a-44171f165ce9",
    "name": "Task #2"
  },
  "jimer": {
    "uid": "17dff65e-434d-4454-bb57-a1167fefbb6b",
    "identifyToken": "sam",
    "username": "Sam",
    "email": null,
    "createdAt": "2025-02-03T11:50:01.000Z",
    "lastActivityAt": "2025-02-21T12:49:37.000Z"
  }
}

Hints

Events related to Jimo Hints

hint.created

A member of your team created a new hint

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
experience	Experience	Hint created
user	User	User who created

Request example

{
  "event": "hint.created",
  "version": "0",
  "time": 1740142759000,
  "experience": {
    "uid": "0e3cbcd7-9280-4e49-a6cb-f9592fbf75fb",
    "title": "New",
    "type": "HINT",
    "state": "LIVE",
    "isDraft": true,
    "publishedAt": null,
    "createdAt": "2025-02-21T12:59:19.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "SINGLE_TIME",
    "recurrencyValue": 1
  },
  "user": {
    "uid": "17de6523-2033-4aaa-a500-d9369b611284",
    "email": "[email protected]",
    "firstName": "Sam",
    "lastName": "at Jimo"
  }
}

hint.published

A member of your team published a hint

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
experience	Experience	Hint published
user	User	User who published

Request example

{
  "event": "hint.published",
  "version": "0",
  "time": 1740142846000,
  "experience": {
    "uid": "0e3cbcd7-9280-4e49-a6cb-f9592fbf75fb",
    "title": "New",
    "type": "HINT",
    "state": "LIVE",
    "isDraft": false,
    "publishedAt": "2025-02-21T13:00:47.000Z",
    "createdAt": "2025-02-21T12:59:19.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "SINGLE_TIME",
    "recurrencyValue": 1
  },
  "user": {
    "uid": "17de6523-2033-4aaa-a500-d9369b611284",
    "email": "[email protected]",
    "firstName": "Sam",
    "lastName": "at Jimo"
  }
}

hint.deleted

A member of your team deleted a hint

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
experience	Experience	Hint deleted
user	User	User who deleted

Request example

{
  "event": "hint.deleted",
  "version": "0",
  "time": 1740142954000,
  "experience": {
    "uid": "0e3cbcd7-9280-4e49-a6cb-f9592fbf75fb",
    "title": "New",
    "type": "HINT",
    "state": "PAUSED",
    "isDraft": false,
    "publishedAt": "2025-02-21T13:00:47.000Z",
    "createdAt": "2025-02-21T12:59:19.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "SINGLE_TIME",
    "recurrencyValue": 1
  },
  "user": {
    "uid": "17de6523-2033-4aaa-a500-d9369b611284",
    "email": "[email protected]",
    "firstName": "Sam",
    "lastName": "at Jimo"
  }
}

hint.status-changed

A member of your team either paused or put live a hint

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
experience	Experience	Hint updated
user	User	User who updated

Request example

{
  "event": "hint.status-changed",
  "version": "0",
  "time": 1740142949000,
  "experience": {
    "uid": "0e3cbcd7-9280-4e49-a6cb-f9592fbf75fb",
    "title": "New",
    "type": "HINT",
    "state": "LIVE",
    "isDraft": false,
    "publishedAt": "2025-02-21T13:00:47.000Z",
    "createdAt": "2025-02-21T12:59:19.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "SINGLE_TIME",
    "recurrencyValue": 1
  },
  "user": {
    "uid": "17de6523-2033-4aaa-a500-d9369b611284",
    "email": "[email protected]",
    "firstName": "Sam",
    "lastName": "at Jimo"
  }
}

hint.seen

A user has seen a hint

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
experience	Experience	Hint seen
jimer	Jimer	User who seen

Request example

{
  "event": "hint.seen",
  "version": "0",
  "time": 1740142933000,
  "experience": {
    "uid": "0e3cbcd7-9280-4e49-a6cb-f9592fbf75fb",
    "title": "New",
    "type": "HINT",
    "state": "LIVE",
    "isDraft": false,
    "publishedAt": "2025-02-21T13:00:47.000Z",
    "createdAt": "2025-02-21T12:59:19.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "SINGLE_TIME",
    "recurrencyValue": 1
  },
  "jimer": {
    "uid": "17dff65e-434d-4454-bb57-a1167fefbb6b",
    "identifyToken": "sam",
    "username": "Sam",
    "email": null,
    "createdAt": "2025-02-03T11:50:01.000Z",
    "lastActivityAt": "2025-02-21T13:02:01.000Z"
  }
}

Banner

Events related to Jimo Banners

banner.created

A member of your team created a new banner

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
experience	Experience	Banner created
user	User	User who created

Request example

{
  "event": "banner.created",
  "version": "0",
  "time": 1740143302000,
  "experience": {
    "uid": "62a81366-9670-4ba7-8e35-baf85b8a90b9",
    "title": "Upcoming maintenance",
    "type": "BANNER",
    "state": "LIVE",
    "isDraft": true,
    "publishedAt": null,
    "createdAt": "2025-02-21T13:08:22.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "SINGLE_TIME",
    "recurrencyValue": 1
  },
  "user": {
    "uid": "17de6523-2033-4aaa-a500-d9369b611284",
    "email": "[email protected]",
    "firstName": "Sam",
    "lastName": "at Jimo"
  }
}

banner.published

A member of your team published a banner

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
experience	Experience	Banner published
user	User	User who published

Request example

{
  "event": "banner.published",
  "version": "0",
  "time": 1740143310000,
  "experience": {
    "uid": "62a81366-9670-4ba7-8e35-baf85b8a90b9",
    "title": "Upcoming maintenance",
    "type": "BANNER",
    "state": "LIVE",
    "isDraft": false,
    "publishedAt": "2025-02-21T13:08:30.000Z",
    "createdAt": "2025-02-21T13:08:22.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "SINGLE_TIME",
    "recurrencyValue": 1
  },
  "user": {
    "uid": "17de6523-2033-4aaa-a500-d9369b611284",
    "email": "[email protected]",
    "firstName": "Sam",
    "lastName": "at Jimo"
  }
}

banner.deleted

A member of your team deleted a banner

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
experience	Experience	Banner deleted
user	User	User who deleted

Request example

{
  "event": "banner.deleted",
  "version": "0",
  "time": 1740143353000,
  "experience": {
    "uid": "62a81366-9670-4ba7-8e35-baf85b8a90b9",
    "title": "Upcoming maintenance",
    "type": "BANNER",
    "state": "PAUSED",
    "isDraft": false,
    "publishedAt": "2025-02-21T13:08:30.000Z",
    "createdAt": "2025-02-21T13:08:22.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "SINGLE_TIME",
    "recurrencyValue": 1
  },
  "user": {
    "uid": "17de6523-2033-4aaa-a500-d9369b611284",
    "email": "[email protected]",
    "firstName": "Sam",
    "lastName": "at Jimo"
  }
}

banner.status-changed

A member of your team either paused or put live a banner

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
experience	Experience	Banner updated
user	User	User who updated

Request example

{
  "event": "banner.status-changed",
  "version": "0",
  "time": 1740143346000,
  "experience": {
    "uid": "62a81366-9670-4ba7-8e35-baf85b8a90b9",
    "title": "Upcoming maintenance",
    "type": "BANNER",
    "state": "LIVE",
    "isDraft": false,
    "publishedAt": "2025-02-21T13:08:30.000Z",
    "createdAt": "2025-02-21T13:08:22.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "SINGLE_TIME",
    "recurrencyValue": 1
  },
  "user": {
    "uid": "17de6523-2033-4aaa-a500-d9369b611284",
    "email": "[email protected]",
    "firstName": "Sam",
    "lastName": "at Jimo"
  }
}

banner.seen

A user has seen a banner

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
experience	Experience	Banner seen
jimer	Jimer	User who seen

Request example

{
  "event": "banner.seen",
  "version": "0",
  "time": 1740143336000,
  "experience": {
    "uid": "62a81366-9670-4ba7-8e35-baf85b8a90b9",
    "title": "Upcoming maintenance",
    "type": "BANNER",
    "state": "LIVE",
    "isDraft": false,
    "publishedAt": "2025-02-21T13:08:30.000Z",
    "createdAt": "2025-02-21T13:08:22.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "SINGLE_TIME",
    "recurrencyValue": 1
  },
  "jimer": {
    "uid": "17dff65e-434d-4454-bb57-a1167fefbb6b",
    "identifyToken": "sam",
    "username": "Sam",
    "email": null,
    "createdAt": "2025-02-03T11:50:01.000Z",
    "lastActivityAt": "2025-02-21T13:08:56.000Z"
  }
}

Posts

Events related to Jimo Changelog Posts

post.created

A member of your team created a new changelog post

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
post	Experience	Post created
user	User	User who created

Request example

{
  "event": "post.created",
  "version": "0",
  "time": 1740143758000,
  "post": {
    "uid": "4c85a092-2f6a-4d0b-bf40-abe6e204801c",
    "title": "New version is live!",
    "type": "POST",
    "state": "LIVE",
    "isDraft": true,
    "publishedAt": null,
    "createdAt": "2025-02-21T13:15:58.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "SINGLE_TIME",
    "recurrencyValue": 1
  },
  "user": {
    "uid": "17de6523-2033-4aaa-a500-d9369b611284",
    "email": "[email protected]",
    "firstName": "Sam",
    "lastName": "at Jimo"
  }
}

post.published

A member of your team published a changelog post

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
post	Experience	Post published
user	User	User who published

Request example

{
  "event": "post.published",
  "version": "0",
  "time": 1740143787000,
  "post": {
    "uid": "4c85a092-2f6a-4d0b-bf40-abe6e204801c",
    "title": "New version is live!",
    "type": "POST",
    "state": "LIVE",
    "isDraft": false,
    "publishedAt": "2025-02-21T13:16:27.388Z",
    "createdAt": "2025-02-21T13:15:58.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "SINGLE_TIME",
    "recurrencyValue": 1
  },
  "user": {
    "uid": "17de6523-2033-4aaa-a500-d9369b611284",
    "email": "[email protected]",
    "firstName": "Sam",
    "lastName": "at Jimo"
  }
}

post.deleted

A member of your team deleted a changelog post

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
post	Experience	Post deleted
user	User	User who deleted

Request example

{
  "event": "post.deleted",
  "version": "0",
  "time": 1740143870000,
  "post": {
    "uid": "4c85a092-2f6a-4d0b-bf40-abe6e204801c",
    "title": "New version is live!",
    "type": "POST",
    "state": "LIVE",
    "isDraft": false,
    "publishedAt": "2025-02-21T13:16:27.000Z",
    "createdAt": "2025-02-21T13:15:58.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "SINGLE_TIME",
    "recurrencyValue": 1
  },
  "user": {
    "uid": "17de6523-2033-4aaa-a500-d9369b611284",
    "email": "[email protected]",
    "firstName": "Sam",
    "lastName": "at Jimo"
  }
}

post.liked

A user liked a changelog post

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
post	Experience	Post liked
jimer	Jimer	User who liked

Request example

{
  "event": "post.liked",
  "version": "0",
  "time": 1740143836000,
  "post": {
    "uid": "4c85a092-2f6a-4d0b-bf40-abe6e204801c",
    "title": "New version is live!",
    "type": "POST",
    "state": "LIVE",
    "isDraft": false,
    "publishedAt": "2025-02-21T13:16:27.000Z",
    "createdAt": "2025-02-21T13:15:58.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "SINGLE_TIME",
    "recurrencyValue": 1
  },
  "jimer": {
    "uid": "17dff65e-434d-4454-bb57-a1167fefbb6b",
    "identifyToken": "sam",
    "username": "Sam",
    "email": null,
    "createdAt": "2025-02-03T11:50:01.000Z",
    "lastActivityAt": "2025-02-21T13:16:33.000Z"
  }
}

post.commented

A user commented a changelog post

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
post	Experience	Post commented
comment	Comment	Comment of the user
jimer	Jimer	User who commented

Request example

{
  "event": "post.commented",
  "version": "0",
  "time": 1740143847000,
  "post": {
    "uid": "4c85a092-2f6a-4d0b-bf40-abe6e204801c",
    "title": "New version is live!",
    "type": "POST",
    "state": "LIVE",
    "isDraft": false,
    "publishedAt": "2025-02-21T13:16:27.000Z",
    "createdAt": "2025-02-21T13:15:58.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "SINGLE_TIME",
    "recurrencyValue": 1
  },
  "jimer": {
    "uid": "17dff65e-434d-4454-bb57-a1167fefbb6b",
    "identifyToken": "sam",
    "username": "Sam",
    "email": null,
    "createdAt": "2025-02-03T11:50:01.000Z",
    "lastActivityAt": "2025-02-21T13:16:33.000Z"
  },
  "comment": {
    "uid": "693dc5a2-93a7-49fa-b3dd-313198889415",
    "message": "That's so awesome!"
  }
}

post.cta.clicked

A CTA has been clicked by a user in a tour

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
experience	Experience	Post completed
jimer	Jimer	User who clicked
cta	CTA	CTA Clicked

Request example

{
  "event": "post.cta.clicked",
  "version": "0",
  "time": 1740143847000,
  "post": {
    "uid": "4c85a092-2f6a-4d0b-bf40-abe6e204801c",
    "title": "New version is live!",
    "type": "POST",
    "state": "LIVE",
    "isDraft": false,
    "publishedAt": "2025-02-21T13:16:27.000Z",
    "createdAt": "2025-02-21T13:15:58.000Z",
    "expiresAt": null,
    "triggerType": "DEFAULT",
    "recurrencyType": "SINGLE_TIME",
    "recurrencyValue": 1
  },
  "jimer": {
    "uid": "17dff65e-434d-4454-bb57-a1167fefbb6b",
    "identifyToken": "sam",
    "username": "Sam",
    "email": null,
    "createdAt": "2025-02-03T11:50:01.000Z",
    "lastActivityAt": "2025-02-21T13:16:33.000Z"
  },
  "comment": {
    "uid": "693dc5a2-93a7-49fa-b3dd-313198889415",
    "message": "That's so awesome!"
  },
  "cta": {
    "uid": "284cd43f-81ae-481e-85df-e4f45141d1c9",
    "type": "PRIMARY_CTA",
    "text": "Discover"
  }
}

Feedback

Events related to Jimo Changelog Feedback

request.created

A feedback has been submitted

Name	Type	Description
event	string	Name of the event
version	string	Version of the webhook api
time	string	Date of trigger
request	Request	Request submitted
jimer	Jimer	User who submitted
project	CTA	Project

Request example

{
  "event": "request.created",
  "version": "0",
  "time": 1740143847000,
  "request": {
    "uid": "7f2d5da0-b5c5-45fb-901b-e8c0b2f69eec",
    "title": "A brand new feature",
    "content": "Non laborum laborum nostrud id proident qui do mollit ex excepteur excepteur sint."
  },
  "jimer": {
    "uid": "17dff65e-434d-4454-bb57-a1167fefbb6b",
    "identifyToken": "sam",
    "username": "Sam",
    "email": null,
    "createdAt": "2025-02-03T11:50:01.000Z",
    "lastActivityAt": "2025-02-21T13:16:33.000Z"
  },
  "projet": {
    "uid": "496d08c6-e5f0-49b2-8a6c-e9b35e75562c",
    "name": "My SaaS"
  }
}