< All Topics

Events List

Playlist Events

playlist.opened

Fires when a published playlist is opened
JSON
				{
    "playlistId": "string",
    "contactId": "string",
    "sharedById": "string",
    "playlistUrl": "string",
    "title": "string",
    "name": "string",
    "created": "2023-05-24T10:00:00.000Z"
  }
			

playlist.sent

Fires when a published playlist is sent
JSON
				{
    "playlistId": "string",
    "sender": {
      "id": "string",
      "firstName": "string",
      "lastName": "string"
    },
    "contactId": "string",
    "playlistUrl": "string",
    "title": "string",
    "name": "string",
    "channel": "string",
    "destination": "string",
    "created": "2023-05-24T10:00:00.000Z"
  }

			

playlist.shared

Fires when a published playlist is shared
JSON
				{
    "playlistId": "string",
    "contactId": "string",
    "playlistUrl": "string",
    "title": "string",
    "name": "string",
    "sharedWithId": "string",
    "created": "2023-05-24T10:00:00.000Z"
  }
			

playlist.link_clicked

Fires when a link is clicked in a published playlist
JSON
				{
    "playlistId": "string",
    "contactId": "string",
    "playlistUrl": "string",
    "title": "string",
    "name": "string",
    "linkUrl": "string",
    "created": "2023-05-24T10:00:00.000Z"
  }
			

Contact Events

contact.created

Fires when a new contact is created
JSON
				{
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "emailAddresses": [
      "string"
    ],
    "phoneNumbers": [
      "string"
    ],
    "whatsAppNumbers": [
      "string"
    ],
    "properties": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  }
			

contact.updated

Fires when a contact is updated
JSON
				{
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "emailAddresses": [
      "string"
    ],
    "phoneNumbers": [
      "string"
    ],
    "whatsAppNumbers": [
      "string"
    ],
    "properties": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  }

			

contact.unsubscribed

Fires when a contact unsubscribes from a playlist distribution by email
JSON
				{
    "id": "string",
    "channel": "string",
    "destination": "string",
    "firstName": "string",
    "lastName": "string",
    "emailAddresses": [
      "string"
    ],
    "phoneNumbers": [
      "string"
    ],
    "whatsAppNumbers": [
      "string"
    ],
    "properties": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  }


			

contact.resubscribed

Fires when a manager resubscribes a contact
JSON
				{
    "id": "string",
    "channel": "string",
    "destination": "string",
    "firstName": "string",
    "lastName": "string",
    "emailAddresses": [
      "string"
    ],
    "phoneNumbers": [
      "string"
    ],
    "whatsAppNumbers": [
      "string"
    ],
    "properties": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  }
			
Table of Contents