User events

This page documents webhook request payloads for user events. For an overview, see Webhook event types.

Detail object properties

For user events, the detail object contains the following properties from the user resource schema:

• created_at
• email
• external_id
• default_group_id (returned as a string)
• id (returned as a string)
• organization_id (returned as a string)
• role
• updated_at

Event types

The following sections contain example payloads and event object properties for user event types.

Event type	Payload and properties
zen:event-type:user.alias_changed	Support User Alias Changed
zen:event-type:user.created	Support User Created
zen:event-type:user.custom_field_changed	Support User Custom Field Changed
zen:event-type:user.custom_role_changed	Support User Custom Role Changed
zen:event-type:user.default_group_changed	Support User Default Group Changed
zen:event-type:user.details_changed	Support User Details Changed
zen:event-type:user.external_id_changed	Support User External ID Changed
zen:event-type:user.group_membership_created	Support User Group Membership Created
zen:event-type:user.group_membership_deleted	Support User Group Membership Deleted
zen:event-type/user.identity_changed	Support User Identity Changed
zen:event-type/user.identity_created	Support User Identity Created
zen:event-type:user.identity_deleted	Support User Identity Deleted
zen:event-type:user.active_changed	Support User Active Status Changed
zen:event-type:user.last_login_changed	Support User Last Login Changed
zen:event-type/user.merged	Support User Merged
zen:event-type:user.name_changed	Support User Name Changed
zen:event-type:user.notes_changed	Support User Notes Changed
zen:event-type:user.only_private_comments_changed	Support User Only Private Comments Status Changed
zen:event-type:user.organization_membership_created	Support User Organization Membership Created
zen:event-type:user.organization_membership_deleted	Support User Organization Membership Deleted
zen:event-type:user.password_changed	Support User Password Changed
zen:event-type:user.photo_changed	Support User Photo Changed
zen:event-type:user.role_changed	Support User Role Changed
zen:event-type:user.deleted	Support User Deleted
zen:event-type:user.suspended_changed	Support User Suspended Status Changed
zen:event-type:user.tags_changed	Support User Tags Changed
zen:event-type:user.time_zone_changed	Support User Time Zone Changed

Support User Alias Changed

A user's alias changed.

{
  "type": "zen:event-type:user.alias_changed",
  "account_id": 12514403,
  "id": "6b9bbadf-5725-4e92-bebe-7b71011bf5f1",
  "subject": "zen:user:6596848315901",
  "time": "2099-07-04T05:33:18Z",
  "zendesk_event_version": "2022-06-20",
  "detail": {
    "created_at": "2099-07-04T05:27:58Z",
    "email": "[email protected]",
    "external_id": "",
    "default_group_id": "0",
    "id": "6596848315901",
    "organization_id": "0",
    "role": "end-user",
    "updated_at": "2099-07-04T05:33:18Z"
  },
  "event": {
    "current": "Joe",
    "previous": "Joseph"
  }
}

The event object contains the following properties.

Property	Data type	Description
current	string	Current alias
previous	string	Previous alias

Support User Created

A user was created.

{
  "type": "zen:event-type:user.created",
  "account_id": 12514403,
  "id": "6b9bbadf-5725-4e92-bebe-7b71011bf5f1",
  "subject": "zen:user:6596848315901",
  "time": "2099-07-04T05:33:18Z",
  "zendesk_event_version": "2022-06-20",
  "detail": {
    "created_at": "2099-07-04T05:27:58Z",
    "email": "[email protected]",
    "external_id": "",
    "default_group_id": "0",
    "id": "6596848315901",
    "organization_id": "0",
    "role": "end-user",
    "updated_at": "2099-07-04T05:33:18Z"
  },
  "event": {}
}

The payload contains an empty event object.

Support User Custom Field Changed

A user-created custom field was changed by an agent.

{
  "type": "zen:event-type:user.custom_field_changed",
  "account_id": 9732064,
  "id": "697bbd67-869c-4f1f-a47c-b296258c50c8",
  "subject": "zen:user:6596848315901",
  "time": "2099-07-07T05:10:01Z",
  "zendesk_event_version": "2022-06-20",
  "detail": {
    "created_at": "2099-07-01T02:12:33Z",
    "email": "[email protected]",
    "external_id": "3",
    "group_id": "4",
    "id": "6596848315901",
    "organization_id": "5",
    "role": "agent",
    "updated_at": "2099-07-05T01:58:48Z"
  },
  "event": {
    "current": {
      "value": true
    },
    "field": {
      "id": "6607814943229",
      "title": "checkbox_3b02",
      "type": "checkbox"
    },
    "previous": {
      "value": false
    }
  }
}

The event uses a different schema for a custom field with the lookup relationship field type:

{
  "type": "zen:event-type:user.custom_field_changed",
  "account_id": 9732064,
  "id": "697bbd67-869c-4f1f-a47c-b296258c50c8",
  "subject": "zen:user:6596848315901",
  "time": "2099-07-07T05:10:01Z",
  "zendesk_event_version": "2022-06-20",
  "detail": {
    "created_at": "2099-07-01T02:12:33Z",
    "email": "[email protected]",
    "external_id": "3",
    "group_id": "4",
    "id": "6596848315901",
    "organization_id": "5",
    "role": "agent",
    "updated_at": "2099-07-05T01:58:48Z"
  },
  "event": {
    "current": {
      "relationship_target": "user",
      "id": "2"
    },
    "custom_field": {
      "id": "6600020807549",
      "title": "lookup_cuf1",
      "type": "lookup"
    },
    "previous": {
      "relationship_target": "user",
      "id": "1"
    }
  }
}

The event object contains the following properties.

Property	Data type	Description
current	object	Contains the current custom field value
current.value		Current field value. If field.type is "lookup", this property is not included
current.relationship_target	string	Current type of object the lookup relationship field is targeting. Possible values are "ticket", "user" and "organization". Only included if custom_field.type is "lookup"
current.id	string	Current id of the object the lookup relationship field is targeting. Only included if custom_field.type is "lookup"
field	object	Contains the field's configuration
field.id	string	id for the custom field
field.title	string	Custom field name
field.type	string	Field data type. Possible values are "checkbox", "date", "decimal", "integer", "lookup", "regex", "tagger", "text", and "textarea"
previous	object	Contains the previous custom field value
previous.value		Previous field value. If field.type is "lookup", this property is not included
previous.relationship_target	string	Previous type of object the lookup relationship field is targeting. Possible values are "ticket", "user" and "organization". Only included if custom_field.type is "lookup"
previous.id	string	Previous id of the object the lookup relationship field is targeting. Only included if custom_field.type is "lookup"

Support User Custom Role Changed

A user's custom role changed.

{
  "type": "zen:event-type:user.custom_role_changed",
  "account_id": 12514403,
  "id": "6b9bbadf-5725-4e92-bebe-7b71011bf5f1",
  "subject": "zen:user:6596848315901",
  "time": "2099-07-04T05:33:18Z",
  "zendesk_event_version": "2022-06-20",
  "detail": {
    "created_at": "2099-07-04T05:27:58Z",
    "email": "[email protected]",
    "external_id": "",
    "default_group_id": "0",
    "id": "6596848315901",
    "organization_id": "0",
    "role": "end-user",
    "updated_at": "2099-07-04T05:33:18Z"
  },
  "event": {
    "current": "1",
    "previous": "4"
  }
}

The event object contains the following properties.

Property	Data type	Description
current	string	Current permission set id for the user's custom role
previous	string	Previous permission set id for the user's custom role

Support User Default Group Changed

A user's default group changed.

{
  "type": "zen:event-type:user.default_group_changed",
  "account_id": 12514403,
  "id": "6b9bbadf-5725-4e92-bebe-7b71011bf5f1",
  "subject": "zen:user:6596848315901",
  "time": "2099-07-04T05:33:18Z",
  "zendesk_event_version": "2022-06-20",
  "detail": {
    "created_at": "2099-07-04T05:27:58Z",
    "email": "[email protected]",
    "external_id": "",
    "default_group_id": "0",
    "id": "6596848315901",
    "organization_id": "0",
    "role": "end-user",
    "updated_at": "2099-07-04T05:33:18Z"
  },
  "event": {
    "current": "1",
    "previous": "2"
  }
}

The event object contains the following properties.

Property	Data type	Description
current	string	Current group id
previous	string	Previous group id

Support User Details Changed

A user's details changed.

{
  "type": "zen:event-type:user.details_changed",
  "account_id": 12514403,
  "id": "6b9bbadf-5725-4e92-bebe-7b71011bf5f1",
  "subject": "zen:user:6596848315901",
  "time": "2099-07-04T05:33:18Z",
  "zendesk_event_version": "2022-06-20",
  "detail": {
    "created_at": "2099-07-04T05:27:58Z",
    "default_group_id": "0",
    "email": "[email protected]",
    "external_id": "",
    "id": "6596848315901",
    "organization_id": "0",
    "role": "end-user",
    "updated_at": "2099-07-04T05:33:18Z"
  },
  "event": {
    "current": "User's printer was on fire",
    "previous": ""
  }
}

The event object contains the following properties.

Property	Data type	Description
current	string	Current user details
previous	string	Previous user details

Support User External ID Changed

A user's external id changed.

{
  "type": "zen:event-type:user.external_id_changed",
  "account_id": 12514403,
  "id": "6b9bbadf-5725-4e92-bebe-7b71011bf5f1",
  "subject": "zen:user:6596848315901",
  "time": "2099-07-04T05:33:18Z",
  "zendesk_event_version": "2022-06-20",
  "detail": {
    "created_at": "2099-07-04T05:27:58Z",
    "default_group_id": "0",
    "email": "[email protected]",
    "external_id": "",
    "id": "6596848315901",
    "organization_id": "0",
    "role": "end-user",
    "updated_at": "2099-07-04T05:33:18Z"
  },
  "event": {
    "current": "1",
    "previous": "2"
  }
}

The event object contains the following properties.

Property	Data type	Description
current	string	Current external id
previous	string	Previous external id

Support User Group Membership Created

A user was added to a group.

{
  "type": "zen:event-type:user.group_membership_created",
  "account_id": 12514403,
  "id": "6b9bbadf-5725-4e92-bebe-7b71011bf5f1",
  "subject": "zen:user:6596848315901",
  "time": "2099-07-04T05:33:18Z",
  "zendesk_event_version": "2022-06-20",
  "detail": {
    "created_at": "2099-07-04T05:27:58Z",
    "default_group_id": "0",
    "email": "[email protected]",
    "external_id": "",
    "id": "6596848315901",
    "organization_id": "0",
    "role": "end-user",
    "updated_at": "2099-07-04T05:33:18Z"
  },
  "event": {
    "group": {
      "id": "1"
    }
  }
}

The event object contains the following properties.

Property	Data type	Description
group	object	Contains the group id
group.id	string	id of the group

Support User Group Membership Deleted

A user was removed from a group.

{
  "type": "zen:event-type:user.group_membership_deleted",
  "account_id": 12514403,
  "id": "6b9bbadf-5725-4e92-bebe-7b71011bf5f1",
  "subject": "zen:user:6596848315901",
  "time": "2099-07-04T05:33:18Z",
  "zendesk_event_version": "2022-06-20",
  "detail": {
    "created_at": "2099-07-04T05:27:58Z",
    "default_group_id": "0",
    "email": "[email protected]",
    "external_id": "",
    "id": "6596848315901",
    "organization_id": "0",
    "role": "end-user",
    "updated_at": "2099-07-04T05:33:18Z"
  },
  "event": {
    "group": {
      "id": "1"
    }
  }
}

The event object contains the following properties.

Property	Data type	Description
group	object	Contains the group id
group.id	string	id of the group

Support User Identity Changed

A user's identity changed.

{
  "type": "zen:event-type:user.identity_changed",
  "account_id": 12514403,
  "id": "6b9bbadf-5725-4e92-bebe-7b71011bf5f1",
  "subject": "zen:user:6596848315901",
  "time": "2099-07-04T05:33:18Z",
  "zendesk_event_version": "2022-06-20",
  "detail": {
    "created_at": "2099-07-04T05:27:58Z",
    "default_group_id": "0",
    "email": "[email protected]",
    "external_id": "",
    "id": "6596848315901",
    "organization_id": "0",
    "role": "end-user",
    "updated_at": "2099-07-04T05:33:18Z"
  },
  "event": {
    "current": {
      "id": "1",
      "primary": true,
      "type": "email",
      "value": "[email protected]"
    },
    "previous": {
      "id": "2",
      "primary": true,
      "type": "email",
      "value": "[email protected]"
    }
  }
}

The event object contains the following properties.

Property	Data type	Description
current	object	Current user identity. For object properties, see the user identity resource schema
previous	object	Previous user identity. For object properties, see the user identity resource schema

Support User Identity Created

A user's identity was created.

{
  "type": "zen:event-type:user.identity_created",
  "account_id": 13390837,
  "id": "40b97155-4255-4637-b4ca-c611a5b5cf68",
  "subject": "zen:user:6600130024829",
  "time": "2099-07-05T01:58:48Z",
  "zendesk_event_version": "2022-06-20",
  "detail": {
    "created_at": "2099-07-05T01:58:48Z",
    "email": "[email protected]",
    "external_id": "",
    "default_group_id": "0",
    "id": "6600130024829",
    "organization_id": "0",
    "role": "agent",
    "updated_at": "2099-07-05T01:58:48Z"
  },
  "event": {
    "identity": {
      "id": "6600130025725",
      "primary": true,
      "type": "email",
      "value": "[email protected]"
    }
  }
}

The event object contains the following properties.

Property	Data type	Description
identity	object	User identity. For object properties, see the user identity resource schema

Support User Identity Deleted

A user's identity was deleted.

{
  "type": "zen:event-type:user.identity_deleted",
  "account_id": 13390837,
  "id": "40b97155-4255-4637-b4ca-c611a5b5cf68",
  "subject": "zen:user:6600130024829",
  "time": "2099-07-05T01:58:48Z",
  "zendesk_event_version": "2022-06-20",
  "detail": {
    "created_at": "2099-07-05T01:58:48Z",
    "default_group_id": "0",
    "email": "[email protected]",
    "external_id": "",
    "id": "6600130024829",
    "organization_id": "0",
    "role": "agent",
    "updated_at": "2099-07-05T01:58:48Z"
  },
  "event": {
    "identity": {
      "id": "6600130025725",
      "primary": true,
      "type": "email",
      "value": "[email protected]"
    }
  }
}

The event object contains the following properties.

Property	Data type	Description
identity	object	User identity. For object properties, see the user identity resource schema

Support User Active Status Changed

A user's active status changed.

{
  "type": "zen:event-type:user.active_changed",
  "account_id": 12514403,
  "id": "2b24ef10-19d4-4740-93cf-8f98ec4776c0",
  "subject": "zen:user:6596848315901",
  "time": "2099-07-04T05:33:18Z",
  "zendesk_event_version": "2022-06-20",
  "detail": {
    "created_at": "2099-07-04T05:27:58Z",
    "email": "[email protected]",
    "external_id": "",
    "default_group_id": "0",
    "id": "6596848315901",
    "organization_id": "0",
    "role": "end-user",
    "updated_at": "2099-07-04T05:33:18Z"
  },
  "event": {
    "current": false,
    "previous": true
  }
}

The event object contains the following properties.

Property	Data type	Description
current	boolean	Current active status. If the user was soft deleted, current is false
previous	boolean	Previous active status

Support User Last Login Changed

A user's last login time changed. The last login date is updated only if the previous login occurred more than 20 minutes ago.

{
  "type": "zen:event-type:user.last_login_changed",
  "account_id": 13390837,
  "id": "40b97155-4255-4637-b4ca-c611a5b5cf68",
  "subject": "zen:user:6600130024829",
  "time": "2099-07-05T01:58:48Z",
  "zendesk_event_version": "2022-06-20",
  "detail": {
    "created_at": "2099-07-05T01:58:48Z",
    "default_group_id": "0",
    "email": "[email protected]",
    "external_id": "",
    "id": "6600130024829",
    "organization_id": "0",
    "role": "agent",
    "updated_at": "2099-07-05T01:58:48Z"
  },
  "event": {
    "current": "2099-07-05T01:58:48Z",
    "previous": "2099-07-04T01:58:48Z"
  }
}

The event object contains the following properties.

Property	Data type	Description
current	string	Current login timestamp for the user
previous	string	Previous login timestamp for the user

Support User Merged

A user was merged with another user.

{
  "type": "zen:event-type:user.merged",
  "account_id": 13390837,
  "id": "40b97155-4255-4637-b4ca-c611a5b5cf68",
  "subject": "zen:user:6600130024829",
  "time": "2099-07-05T01:58:48Z",
  "zendesk_event_version": "2022-06-20",
  "detail": {
    "created_at": "2099-07-05T01:58:48Z",
    "default_group_id": "0",
    "email": "[email protected]",
    "external_id": "",
    "id": "6600130024829",
    "organization_id": "0",
    "role": "agent",
    "updated_at": "2099-07-05T01:58:48Z"
  },
  "event": {
    "user": {
      "id": "2"
    }
  }
}

The event object contains the following properties.

Property	Data type	Description
user	object	Contains the merged user's id
user.id	string	id of the merged user

Support User Name Changed

A user's name changed.

{
  "type": "zen:event-type:user.name_changed",
  "account_id": 13390837,
  "id": "40b97155-4255-4637-b4ca-c611a5b5cf68",
  "subject": "zen:user:6600130024829",
  "time": "2099-07-05T01:58:48Z",
  "zendesk_event_version": "2022-06-20",
  "detail": {
    "created_at": "2099-07-05T01:58:48Z",
    "default_group_id": "0",
    "email": "[email protected]",
    "external_id": "",
    "id": "6600130024829",
    "organization_id": "0",
    "role": "agent",
    "updated_at": "2099-07-05T01:58:48Z"
  },
  "event": {
    "current": "Jane",
    "previous": "Janet"
  }
}

The event object contains the following properties.

Property	Data type	Description
current	string	Current user name
previous	string	Previous user name

Support User Notes Changed

A user's notes changed.

{
  "type": "zen:event-type:user.notes_changed",
  "account_id": 13390837,
  "id": "40b97155-4255-4637-b4ca-c611a5b5cf68",
  "subject": "zen:user:6600130024829",
  "time": "2099-07-05T01:58:48Z",
  "zendesk_event_version": "2022-06-20",
  "detail": {
    "created_at": "2099-07-05T01:58:48Z",
    "default_group_id": "0",
    "email": "[email protected]",
    "external_id": "",
    "id": "6600130024829",
    "organization_id": "0",
    "role": "agent",
    "updated_at": "2099-07-05T01:58:48Z"
  },
  "event": {
    "current": "Johnny is a nice guy!",
    "previous": ""
  }
}

The event object contains the following properties.

Property	Data type	Description
current	string	Current user notes
previous	string	Previous user notes

Support User Only Private Comments Status Changed

A user's ability to create public comments changed. This ability is controlled by the only_private_comments property in the user resource.

{
  "type": "zen:event-type:user.only_private_comments_changed",
  "account_id": 13390837,
  "id": "40b97155-4255-4637-b4ca-c611a5b5cf68",
  "subject": "zen:user:6600130024829",
  "time": "2099-07-05T01:58:48Z",
  "zendesk_event_version": "2022-06-20",
  "detail": {
    "created_at": "2099-07-05T01:58:48Z",
    "default_group_id": "0",
    "email": "[email protected]",
    "external_id": "",
    "id": "6600130024829",
    "organization_id": "0",
    "role": "agent",
    "updated_at": "2099-07-05T01:58:48Z"
  },
  "event": {
    "current": false,
    "previous": true
  }
}

The event object contains the following properties.

Property	Data type	Description
current	boolean	Current value of the user's only_private_comments property
previous	boolean	Previous value of the user's only_private_comments property

Support User Organization Membership Created

A user was added to an organization.

{
  "type": "zen:event-type:user.organization_membership_created",
  "account_id": 13390837,
  "id": "40b97155-4255-4637-b4ca-c611a5b5cf68",
  "subject": "zen:user:6600130024829",
  "time": "2099-07-05T01:58:48Z",
  "zendesk_event_version": "2022-06-20",
  "detail": {
    "created_at": "2099-07-05T01:58:48Z",
    "default_group_id": "0",
    "email": "[email protected]",
    "external_id": "",
    "id": "6600130024829",
    "organization_id": "0",
    "role": "agent",
    "updated_at": "2099-07-05T01:58:48Z"
  },
  "event": {
    "organization": {
      "id": "1"
    }
  }
}

The event object contains the following properties.

Property	Data type	Description
organization	object	Contains the organization id
organization.id	string	id of the organization

Support User Organization Membership Deleted

A user was removed from an organization.

{
  "type": "zen:event-type:user.organization_membership_deleted",
  "account_id": 13390837,
  "id": "40b97155-4255-4637-b4ca-c611a5b5cf68",
  "subject": "zen:user:6600130024829",
  "time": "2099-07-05T01:58:48Z",
  "zendesk_event_version": "2022-06-20",
  "detail": {
    "created_at": "2099-07-05T01:58:48Z",
    "default_group_id": "0",
    "email": "[email protected]",
    "external_id": "",
    "id": "6600130024829",
    "organization_id": "0",
    "role": "agent",
    "updated_at": "2099-07-05T01:58:48Z"
  },
  "event": {
    "organization": {
      "id": "1"
    }
  }
}

The event object contains the following properties.

Property	Data type	Description
organization	object	Contains the organization id
organization.id	string	id of the organization

Support User Password Changed

A user's password changed.

{
  "type": "zen:event-type:user.password_changed",
  "account_id": 12514403,
  "id": "ce84824c-4ba6-411f-875b-a3b0f3bcb8dd",
  "subject": "zen:user:6596848315901",
  "time": "2099-07-04T05:33:18Z",
  "zendesk_event_version": "2022-06-20",
  "detail": {
    "created_at": "2099-07-04T05:27:58Z",
    "email": "[email protected]",
    "external_id": "",
    "default_group_id": "0",
    "id": "6596848315901",
    "organization_id": "0",
    "role": "end-user",
    "updated_at": "2099-07-04T05:33:18Z"
  },
  "event": {}
}

The payload contains an empty event object.

Support User Photo Changed

A user's photo changed.

{
  "type": "zen:event-type:user.photo_changed",
  "account_id": 13390837,
  "id": "40b97155-4255-4637-b4ca-c611a5b5cf68",
  "subject": "zen:user:6600130024829",
  "time": "2099-07-05T01:58:48Z",
  "zendesk_event_version": "2022-06-20",
  "detail": {
    "created_at": "2099-07-05T01:58:48Z",
    "default_group_id": "0",
    "email": "[email protected]",
    "external_id": "",
    "id": "6600130024829",
    "organization_id": "0",
    "role": "agent",
    "updated_at": "2099-07-05T01:58:48Z"
  },
  "event": {
    "current": "https://assets.zendesk.com/def456",
    "previous": "https://assets.zendesk.com/abc123"
  }
}

The event object contains the following properties.

Property	Data type	Description
current	string	Current photo url
previous	string	Previous photo url

Support User Role Changed

A user's role changed.

{
  "type": "zen:event-type:user.role_changed",
  "account_id": 13390837,
  "id": "40b97155-4255-4637-b4ca-c611a5b5cf68",
  "subject": "zen:user:6600130024829",
  "time": "2099-07-05T01:58:48Z",
  "zendesk_event_version": "2022-06-20",
  "detail": {
    "created_at": "2099-07-05T01:58:48Z",
    "default_group_id": "0",
    "email": "[email protected]",
    "external_id": "",
    "id": "6600130024829",
    "organization_id": "0",
    "role": "agent",
    "updated_at": "2099-07-05T01:58:48Z"
  },
  "event": {
    "current": "admin",
    "previous": "end-user"
  }
}

The event object contains the following properties.

Property	Data type	Description
current	string	Current user role
previous	string	Previous user role

Support User Deleted

A user was deleted.

{
  "type": "zen:event-type:user.deleted",
  "account_id": 12514403,
  "id": "6b9bbadf-5725-4e92-bebe-7b71011bf5f1",
  "subject": "zen:user:6596848315901",
  "time": "2099-07-04T05:33:18Z",
  "zendesk_event_version": "2022-06-20",
  "detail": {
    "created_at": "2099-07-04T05:27:58Z",
    "email": "[email protected]",
    "external_id": "",
    "default_group_id": "0",
    "id": "6596848315901",
    "organization_id": "0",
    "role": "end-user",
    "updated_at": "2099-07-04T05:33:18Z"
  },
  "event": {}
}

The payload contains an empty event object.

Support User Suspended Status Changed

A user's suspended status change. For more information, see Suspending a user.

{
  "type": "zen:event-type:user.suspended_changed",
  "account_id": 13390837,
  "id": "40b97155-4255-4637-b4ca-c611a5b5cf68",
  "subject": "zen:user:6600130024829",
  "time": "2099-07-05T01:58:48Z",
  "zendesk_event_version": "2022-06-20",
  "detail": {
    "created_at": "2099-07-05T01:58:48Z",
    "default_group_id": "0",
    "email": "[email protected]",
    "external_id": "",
    "id": "6600130024829",
    "organization_id": "0",
    "role": "agent",
    "updated_at": "2099-07-05T01:58:48Z"
  },
  "event": {
    "current": true,
    "previous": false
  }
}

The event object contains the following properties.

Property	Data type	Description
current	boolean	Current suspended status
previous	boolean	Previous suspended status

Support User Tags Changed

A user's tags changed.

{
  "type": "zen:event-type:user.tags_changed",
  "account_id": 13390837,
  "id": "40b97155-4255-4637-b4ca-c611a5b5cf68",
  "subject": "zen:user:6600130024829",
  "time": "2099-07-05T01:58:48Z",
  "zendesk_event_version": "2022-06-20",
  "detail": {
    "created_at": "2099-07-05T01:58:48Z",
    "default_group_id": "0",
    "email": "[email protected]",
    "external_id": "",
    "id": "6600130024829",
    "organization_id": "0",
    "role": "agent",
    "updated_at": "2099-07-05T01:58:48Z"
  },
  "event": {
    "added": {
      "tags": ["foo"]
    },
    "removed": {
      "tags": ["bar"]
    }
  }
}

The event object contains the following properties.

Property	Data type	Description
added	object	Contains tags added to the user
added.tags	array of strings	Tags added to the user
removed	object	Contains tags removed from the user
removed.tags	array of strings	Tags removed from the user

Support User Time Zone Changed

A user's time zone changed.

{
  "type": "zen:event-type:user.time_zone_changed",
  "account_id": 13390837,
  "id": "40b97155-4255-4637-b4ca-c611a5b5cf68",
  "subject": "zen:user:6600130024829",
  "time": "2099-07-05T01:58:48Z",
  "zendesk_event_version": "2022-06-20",
  "detail": {
    "created_at": "2099-07-05T01:58:48Z",
    "default_group_id": "0",
    "email": "[email protected]",
    "external_id": "",
    "id": "6600130024829",
    "organization_id": "0",
    "role": "agent",
    "updated_at": "2099-07-05T01:58:48Z"
  },
  "event": {
    "current": "Australia/Adelaide",
    "previous": "Australia/Melbourne"
  }
}

The event object contains the following properties.

Property	Data type	Description
current	string	Current time zone
previous	string	Previous time zone