A webhook event for contacts
| Attribute | Type | Description |
|---|---|---|
| after.attributes | array | List of attribute resources of the contact. |
| after.attributes[].label | string | The display name of the attribute this value belongs to. |
| after.attributes[].value | string / integer / number / boolean / object | The value of the attribute. Its JSON type follows dataType: a string, number, boolean or object. For SINGLE_SELECT and MULTI_SELECT attributes this is the display label of the selected option; a MULTI_SELECT attribute carries its first selection here and the full list in values. On GET /v4/contacts and GET /v4/contacts/{identifier}, organizations temporarily enrolled in legacy select compatibility receive the option's legacy UID instead (the value returned before the organization's CRM migration) when exactly one migrated option has that label, and the label otherwise. |
| after.attributes[].values | array[string] | Every selected option label of a MULTI_SELECT attribute, in order. On GET /v4/contacts and GET /v4/contacts/{identifier}, organizations temporarily enrolled in legacy select compatibility receive an option's legacy UID instead (the value returned before the organization's CRM migration) when exactly one migrated option has that label. Null or absent for other data types. |
| after.attributes[].uid | string | Podium unique identifier for attribute. |
| after.attributes[].dataType | string | The data type for the attribute value. |
| after.attributes[].ownerResource.type | string | The scope the attribute belongs to: ORGANIZATION, PRODUCT (an application) or INTEGRATION. |
| after.attributes[].ownerResource.uid | string | Podium unique identifier for the owner: an organization, application or integration uid. |
| after.name | string | The name of the contact resource. |
| after.address.state | string | The state of the address. |
| after.address.city | string | The city of the address. |
| after.address.country | string | The country of the address. |
| after.address.postalCode | string | The postal code of the address. |
| after.address.addressLine1 | string | The first line of the address. |
| after.address.addressLine2 | string | The second line of the address. |
| after.organization.uid | string | Podium unique identifier for the referenced resource. |
| after.channels | array | List of channels for the contact. |
| after.channels[].label | string | A label for the channel. |
| after.channels[].type | string | The type of the channel. |
| after.channels[].identifier | string | The unique identifier for the channel. |
| after.channels[].createdAt | string | Time at which the resource was created. Date time is in Coordinated Universal Time (UTC). |
| after.channels[].updatedAt | string | Time at which the resource was updated. Date time is in Coordinated Universal Time (UTC). |
| after.channels[].marketingOptedInLocationUids | array[string] | Location UIDs where marketing messages are opted in for the contact channel. |
| after.channels[].transactionalOptedOutAt | string | Timestamp when the contact channel opted out of transactional messages. |
| after.uid | string | Podium unique identifier for contact. |
| after.createdAt | string | Time at which the resource was created. Date time is in Coordinated Universal Time (UTC). |
| after.updatedAt | string | Time at which the resource was updated. Date time is in Coordinated Universal Time (UTC). |
| after.tags | array | List of tag resources of the contact. |
| after.tags[].label | string | The label of the tag. |
| after.tags[].description | string | Description of the tag. |
| after.tags[].uid | string | Podium unique identifier for tag. |
| after.locations | array | Reference to the location resource. |
| after.locations[].uid | string | Podium unique identifier for the referenced resource. |
| after.emails | array[string] | List of the contacts email addresses. |
| after.conversations | array | Reference to the conversation resource. |
| after.conversations[].uid | string | Podium unique identifier for the referenced resource. |
| after.phoneNumbers | array[string] | List of the contacts phone numbers. |
| errors | array[string] | A list of errors for an action. |
| before.attributes | array | List of attribute resources of the contact. |
| before.attributes[].label | string | The display name of the attribute this value belongs to. |
| before.attributes[].value | string / integer / number / boolean / object | The value of the attribute. Its JSON type follows dataType: a string, number, boolean or object. For SINGLE_SELECT and MULTI_SELECT attributes this is the display label of the selected option; a MULTI_SELECT attribute carries its first selection here and the full list in values. On GET /v4/contacts and GET /v4/contacts/{identifier}, organizations temporarily enrolled in legacy select compatibility receive the option's legacy UID instead (the value returned before the organization's CRM migration) when exactly one migrated option has that label, and the label otherwise. |
| before.attributes[].values | array[string] | Every selected option label of a MULTI_SELECT attribute, in order. On GET /v4/contacts and GET /v4/contacts/{identifier}, organizations temporarily enrolled in legacy select compatibility receive an option's legacy UID instead (the value returned before the organization's CRM migration) when exactly one migrated option has that label. Null or absent for other data types. |
| before.attributes[].uid | string | Podium unique identifier for attribute. |
| before.attributes[].dataType | string | The data type for the attribute value. |
| before.attributes[].ownerResource.type | string | The scope the attribute belongs to: ORGANIZATION, PRODUCT (an application) or INTEGRATION. |
| before.attributes[].ownerResource.uid | string | Podium unique identifier for the owner: an organization, application or integration uid. |
| before.name | string | The name of the contact resource. |
| before.address.state | string | The state of the address. |
| before.address.city | string | The city of the address. |
| before.address.country | string | The country of the address. |
| before.address.postalCode | string | The postal code of the address. |
| before.address.addressLine1 | string | The first line of the address. |
| before.address.addressLine2 | string | The second line of the address. |
| before.organization.uid | string | Podium unique identifier for the referenced resource. |
| before.channels | array | List of channels for the contact. |
| before.channels[].label | string | A label for the channel. |
| before.channels[].type | string | The type of the channel. |
| before.channels[].identifier | string | The unique identifier for the channel. |
| before.channels[].createdAt | string | Time at which the resource was created. Date time is in Coordinated Universal Time (UTC). |
| before.channels[].updatedAt | string | Time at which the resource was updated. Date time is in Coordinated Universal Time (UTC). |
| before.channels[].marketingOptedInLocationUids | array[string] | Location UIDs where marketing messages are opted in for the contact channel. |
| before.channels[].transactionalOptedOutAt | string | Timestamp when the contact channel opted out of transactional messages. |
| before.uid | string | Podium unique identifier for contact. |
| before.createdAt | string | Time at which the resource was created. Date time is in Coordinated Universal Time (UTC). |
| before.updatedAt | string | Time at which the resource was updated. Date time is in Coordinated Universal Time (UTC). |
| before.tags | array | List of tag resources of the contact. |
| before.tags[].label | string | The label of the tag. |
| before.tags[].description | string | Description of the tag. |
| before.tags[].uid | string | Podium unique identifier for tag. |
| before.locations | array | Reference to the location resource. |
| before.locations[].uid | string | Podium unique identifier for the referenced resource. |
| before.emails | array[string] | List of the contacts email addresses. |
| before.conversations | array | Reference to the conversation resource. |
| before.conversations[].uid | string | Podium unique identifier for the referenced resource. |
| before.phoneNumbers | array[string] | List of the contacts phone numbers. |
{
"after": {
"attributes": [
{
"label": "Eye color",
"value": "Brown eyes",
"values": [
"Brown eyes",
"Green eyes"
],
"uid": "00000000-0000-0000-0000-000000000000",
"dataType": "",
"ownerResource": {
"type": "ORGANIZATION",
"uid": "00000000-0000-0000-0000-000000000000"
}
}
],
"name": "",
"address": {
"state": "",
"city": "",
"country": "",
"postalCode": "",
"addressLine1": "",
"addressLine2": ""
},
"organization": {
"uid": "00000000-0000-0000-0000-000000000000"
},
"channels": [
{
"label": "",
"type": "",
"identifier": "+15555555555",
"createdAt": "2015-01-23T23:50:07Z",
"updatedAt": "2015-01-23T23:50:07Z",
"marketingOptedInLocationUids": [
"00000000-0000-0000-0000-000000000000"
],
"transactionalOptedOutAt": "2015-01-23T23:50:07Z"
}
],
"uid": "00000000-0000-0000-0000-000000000000",
"createdAt": "2015-01-23T23:50:07Z",
"updatedAt": "2015-01-23T23:50:07Z",
"tags": [
{
"label": "",
"description": "",
"uid": "00000000-0000-0000-0000-000000000000"
}
],
"locations": [
{
"uid": "00000000-0000-0000-0000-000000000000"
}
],
"emails": [
""
],
"conversations": [
{
"uid": "00000000-0000-0000-0000-000000000000"
}
],
"phoneNumbers": [
""
]
},
"errors": [
""
],
"before": {
"attributes": [
{
"label": "Eye color",
"value": "Brown eyes",
"values": [
"Brown eyes",
"Green eyes"
],
"uid": "00000000-0000-0000-0000-000000000000",
"dataType": "",
"ownerResource": {
"type": "ORGANIZATION",
"uid": "00000000-0000-0000-0000-000000000000"
}
}
],
"name": "",
"address": {
"state": "",
"city": "",
"country": "",
"postalCode": "",
"addressLine1": "",
"addressLine2": ""
},
"organization": {
"uid": "00000000-0000-0000-0000-000000000000"
},
"channels": [
{
"label": "",
"type": "",
"identifier": "+15555555555",
"createdAt": "2015-01-23T23:50:07Z",
"updatedAt": "2015-01-23T23:50:07Z",
"marketingOptedInLocationUids": [
"00000000-0000-0000-0000-000000000000"
],
"transactionalOptedOutAt": "2015-01-23T23:50:07Z"
}
],
"uid": "00000000-0000-0000-0000-000000000000",
"createdAt": "2015-01-23T23:50:07Z",
"updatedAt": "2015-01-23T23:50:07Z",
"tags": [
{
"label": "",
"description": "",
"uid": "00000000-0000-0000-0000-000000000000"
}
],
"locations": [
{
"uid": "00000000-0000-0000-0000-000000000000"
}
],
"emails": [
""
],
"conversations": [
{
"uid": "00000000-0000-0000-0000-000000000000"
}
],
"phoneNumbers": [
""
]
}
}