A webhook event for contacts
Attribute | Type | Description |
---|---|---|
after.attributes | array | List of attribute resources of the contact. |
after.attributes[].label | string | The label of the attribute. |
after.attributes[].value | string | The value of the attribute. |
after.attributes[].uid | string | Podium unique identifier for attribute. |
after.attributes[].dataType | string | The data type for the attribute value. Possible values: ["ADDRESS", "BOOLEAN", "DATETIME", "FLOAT", "INTEGER", "STRING", "UUID", "SINGLE_SELECT", "MULTI_SELECT"] |
after.attributes[].ownerResource.type | string | Product or organization |
after.attributes[].ownerResource.uid | string | Podium unique identifier for attribute. |
after.name | string | The name of the contact resource. |
after.address.state | string | The state of the address. |
after.address.country | string | The country of the address. |
after.address.city | string | The city of the address. |
after.address.addressLine1 | string | The first line of the address. |
after.address.addressLine2 | string | The second line of the address. |
after.address.postalCode | string | The postal code of the address. |
after.organization.uid | string | Podium unique identifier for the referenced resource. |
after.tags | array | List of tag resources of the contact. |
after.tags[].label | string | The label of the attribute. |
after.tags[].description | string | Description of the tag. |
after.tags[].uid | string | Podium unique identifier for tag. |
after.uid | string | Podium unique identifier for contact. |
after.channels | array | |
after.channels[].label | string | A label for the channel. |
after.channels[].type | string | The type of the channel. Possible values: ["EMAIL", "PHONE"] |
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[].transactionalOptedOutAt | string | Timestamp when the contact channel opted out of transactional messages. |
after.channels[].marketingOptedInLocationUids | array[string] | Location UIDs where marketing messages are opted in for the contact channel. |
after.locations | array | Reference to the location resource. |
after.locations[].uid | string | Podium unique identifier for the referenced resource. |
after.conversations | array | Reference to the conversation resource. |
after.conversations[].uid | string | Podium unique identifier for the referenced resource. |
after.phoneNumbers | array[string] | |
after.emails | array[string] | |
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). |
errors | array[string] | |
before.attributes | array | List of attribute resources of the contact. |
before.attributes[].label | string | The label of the attribute. |
before.attributes[].value | string | The value of the attribute. |
before.attributes[].uid | string | Podium unique identifier for attribute. |
before.attributes[].dataType | string | The data type for the attribute value. Possible values: ["ADDRESS", "BOOLEAN", "DATETIME", "FLOAT", "INTEGER", "STRING", "UUID", "SINGLE_SELECT", "MULTI_SELECT"] |
before.attributes[].ownerResource.type | string | Product or organization |
before.attributes[].ownerResource.uid | string | Podium unique identifier for attribute. |
before.name | string | The name of the contact resource. |
before.address.state | string | The state of the address. |
before.address.country | string | The country of the address. |
before.address.city | string | The city of the address. |
before.address.addressLine1 | string | The first line of the address. |
before.address.addressLine2 | string | The second line of the address. |
before.address.postalCode | string | The postal code of the address. |
before.organization.uid | string | Podium unique identifier for the referenced resource. |
before.tags | array | List of tag resources of the contact. |
before.tags[].label | string | The label of the attribute. |
before.tags[].description | string | Description of the tag. |
before.tags[].uid | string | Podium unique identifier for tag. |
before.uid | string | Podium unique identifier for contact. |
before.channels | array | |
before.channels[].label | string | A label for the channel. |
before.channels[].type | string | The type of the channel. Possible values: ["EMAIL", "PHONE"] |
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[].transactionalOptedOutAt | string | Timestamp when the contact channel opted out of transactional messages. |
before.channels[].marketingOptedInLocationUids | array[string] | Location UIDs where marketing messages are opted in for the contact channel. |
before.locations | array | Reference to the location resource. |
before.locations[].uid | string | Podium unique identifier for the referenced resource. |
before.conversations | array | Reference to the conversation resource. |
before.conversations[].uid | string | Podium unique identifier for the referenced resource. |
before.phoneNumbers | array[string] | |
before.emails | array[string] | |
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). |
{
"after": {
"attributes": [
{
"label": "",
"value": "",
"uid": "00000000-0000-0000-0000-000000000000",
"dataType": "ADDRESS",
"ownerResource": {
"type": "",
"uid": "00000000-0000-0000-0000-000000000000"
}
}
],
"name": "",
"address": {
"state": "",
"country": "",
"city": "",
"addressLine1": "",
"addressLine2": "",
"postalCode": ""
},
"organization": {
"uid": "00000000-0000-0000-0000-000000000000"
},
"tags": [
{
"label": "",
"description": "",
"uid": "00000000-0000-0000-0000-000000000000"
}
],
"uid": "00000000-0000-0000-0000-000000000000",
"channels": [
{
"label": "",
"type": "EMAIL",
"identifier": "+15555555555",
"createdAt": "2015-01-23T23:50:07Z",
"updatedAt": "2015-01-23T23:50:07Z",
"transactionalOptedOutAt": "2015-01-23T23:50:07Z",
"marketingOptedInLocationUids": [
"00000000-0000-0000-0000-000000000000"
]
}
],
"locations": [
{
"uid": "00000000-0000-0000-0000-000000000000"
}
],
"conversations": [
{
"uid": "00000000-0000-0000-0000-000000000000"
}
],
"phoneNumbers": [
""
],
"emails": [
""
],
"createdAt": "2015-01-23T23:50:07Z",
"updatedAt": "2015-01-23T23:50:07Z"
},
"errors": [
""
],
"before": {
"attributes": [
{
"label": "",
"value": "",
"uid": "00000000-0000-0000-0000-000000000000",
"dataType": "ADDRESS",
"ownerResource": {
"type": "",
"uid": "00000000-0000-0000-0000-000000000000"
}
}
],
"name": "",
"address": {
"state": "",
"country": "",
"city": "",
"addressLine1": "",
"addressLine2": "",
"postalCode": ""
},
"organization": {
"uid": "00000000-0000-0000-0000-000000000000"
},
"tags": [
{
"label": "",
"description": "",
"uid": "00000000-0000-0000-0000-000000000000"
}
],
"uid": "00000000-0000-0000-0000-000000000000",
"channels": [
{
"label": "",
"type": "EMAIL",
"identifier": "+15555555555",
"createdAt": "2015-01-23T23:50:07Z",
"updatedAt": "2015-01-23T23:50:07Z",
"transactionalOptedOutAt": "2015-01-23T23:50:07Z",
"marketingOptedInLocationUids": [
"00000000-0000-0000-0000-000000000000"
]
}
],
"locations": [
{
"uid": "00000000-0000-0000-0000-000000000000"
}
],
"conversations": [
{
"uid": "00000000-0000-0000-0000-000000000000"
}
],
"phoneNumbers": [
""
],
"emails": [
""
],
"createdAt": "2015-01-23T23:50:07Z",
"updatedAt": "2015-01-23T23:50:07Z"
}
}