User events

The following user events for Amazon EventBridge include:

Active Status Changed

An event when a user's status changed, false if the user has been soft deleted

Example

{
  "version": "0",
  "id": "31187aa5-67d2-4eea-a921-38535bf6ec3b",
  "detail-type": "Support User: Active Status Changed",
  "source": "aws.partner/zendesk.com/9242270/default",
  "account": "123456789012",
  "time": "2020-01-20T22:55:31Z",
  "region": "us-east-1",
  "resources": ["Support User"],
  "detail": {
    "user_event": {
      "meta": {
        "version": "1.0",
        "occurred_at": "2020-01-20T22:55:29Z",
        "ref": "1-1234567890",
        "sequence": {
          "id": "35D52F7D44640033CCCE4A5F1ADDB2AA",
          "position": 2,
          "total": 9
        }
      },
      "type": "Active Status Changed",
      "previous": true,
      "current": false,
      "user": {
        "id": 35436,
        "external_id": "SF12345",
        "role": "agent",
        "email": "[email protected]",
        "created_at": "2020-01-20T22:55:29Z",
        "updated_at": "2020-01-20T22:55:29Z",
        "organization_id": 10002,
        "default_group_id": 98738
      }
    }
  }
}

The event contains the following unique properties in the user_event object:

  • previous - The previous active status
  • current - The current active status

Alias Changed

An event when user's alias has been changed.

Example

{
  "version": "0",
  "id": "31187aa5-67d2-4eea-a921-38535bf6ec3b",
  "detail-type": "Support User: Alias Changed",
  "source": "aws.partner/zendesk.com/9242270/default",
  "account": "123456789012",
  "time": "2020-01-20T22:55:31Z",
  "region": "us-east-1",
  "resources": ["Support User"],
  "detail": {
    "user_event": {
      "meta": {
        "version": "1.0",
        "occurred_at": "2020-01-20T22:55:29Z",
        "ref": "1-1234567890",
        "sequence": {
          "id": "35D52F7D44640033CCCE4A5F1ADDB2AA",
          "position": 4,
          "total": 9
        }
      },
      "type": "Alias Changed",
      "previous": "abc",
      "current": "edf",
      "user": {
        "id": 35436,
        "external_id": "SF12345",
        "role": "agent",
        "email": "[email protected]",
        "created_at": "2020-01-20T22:55:29Z",
        "updated_at": "2020-01-20T22:55:29Z",
        "organization_id": 10002,
        "default_group_id": 98738
      }
    }
  }
}

The event contains the following unique properties in the user_event object:

  • previous - The previous alias
  • current - The current alias

Custom Field Changed

Custom Field Changed events occur when the value of a user-created custom field is changed by an agent.

Zendesk supports a range of custom field types such as text, numbers, and dates. For more information about custom fields, see About custom field types.

Custom Field Changed events includes a custom_field object with three parameters:

  • id - The Zendesk ID of the custom field
  • title - The custom field name
  • field_type - The field data type (such as date, text, integer, and multi-select)

Custom Field Changed - Checkbox

An event where the value of a custom field checkbox is changed.

Example

{
  "version": "0",
  "id": "7369d9e1-8b2c-4b05-a813-e66d76b8d8f1",
  "detail-type": "Support User: Custom Field Changed",
  "source": "aws.partner/zendesk.com/9242270/default",
  "account": "123456789012",
  "time": "2020-01-25T01:23:48Z",
  "region": "us-east-1",
  "resources": ["Support User"],
  "detail": {
    "user_event": {
      "meta": {
        "version": "1.0",
        "occurred_at": "2020-01-25T01:23:45Z",
        "ref": "1-1234567890",
        "sequence": {
          "id": "0572B2EE0A2B22E5EE8BB107928D7E6D",
          "position": 1,
          "total": 3
        }
      },
      "type": "Custom Field Changed",
      "custom_field": {
        "id": 1234,
        "title": "VIP",
        "field_type": "checkbox"
      },
      "previous": false,
      "current": true,
      "user": {
        "id": 35436,
        "external_id": "SF12345",
        "role": "agent",
        "email": "[email protected]",
        "created_at": "2020-01-20T01:23:45Z",
        "updated_at": "2020-01-25T01:23:45Z",
        "organization_id": 10002,
        "default_group_id": 98738
      }
    }
  }
}

The event contains the following unique properties in the user_event object:

  • previous - The previous boolean value
  • current - The current boolean value

Custom Field Changed - Date

An event where the value of a date custom field is changed.

Example

{
  "version": "0",
  "id": "7369d9e1-8b2c-4b05-a813-e66d76b8d8f1",
  "detail-type": "Support User: Custom Field Changed",
  "source": "aws.partner/zendesk.com/9242270/default",
  "account": "123456789012",
  "time": "2020-01-20T22:55:29Z",
  "region": "us-east-1",
  "resources": ["Support User"],
  "detail": {
    "user_event": {
      "meta": {
        "version": "1.0",
        "occurred_at": "2020-01-20T22:55:29Z",
        "ref": "1-1234567890",
        "sequence": {
          "id": "0572B2EE0A2B22E5EE8BB107928D7E6D",
          "position": 2,
          "total": 7
        }
      },
      "type": "Custom Field Changed",
      "custom_field": {
        "id": 1234,
        "title": "Start Date",
        "field_type": "date"
      },
      "previous": "2020-01-10",
      "current": "2020-01-25",
      "user": {
        "id": 35436,
        "external_id": "SF12345",
        "role": "agent",
        "email": "[email protected]",
        "created_at": "2020-01-20T22:50:29Z",
        "updated_at": "2020-01-20T22:55:29Z",
        "organization_id": 10002,
        "default_group_id": 98738
      }
    }
  }
}

The event contains the following unique properties in the user_event object:

  • previous - The previous date and time
  • current - The current date and time

Custom Field Changed - Decimal

An event where the value of a decimal custom field is changed.

Example

{
  "version": "0",
  "id": "7369d9e1-8b2c-4b05-a813-e66d76b8d8f1",
  "detail-type": "Support User: Custom Field Changed",
  "source": "aws.partner/zendesk.com/9242270/default",
  "account": "123456789012",
  "time": "2020-01-25T01:23:48Z",
  "region": "us-east-1",
  "resources": ["Support User"],
  "detail": {
    "user_event": {
      "meta": {
        "version": "1.0",
        "occurred_at": "2020-01-25T01:23:45Z",
        "ref": "1-1234567890",
        "sequence": {
          "id": "0572B2EE0A2B22E5EE8BB107928D7E6D",
          "position": 2,
          "total": 3
        }
      },
      "type": "Custom Field Changed",
      "custom_field": {
        "id": 1234,
        "title": "Decimal Field",
        "field_type": "decimal"
      },
      "previous": "99.99",
      "current": "100.00",
      "user": {
        "id": 35436,
        "external_id": "SF12345",
        "role": "agent",
        "email": "[email protected]",
        "created_at": "2020-01-20T22:50:29Z",
        "updated_at": "2020-01-25T01:23:45Z",
        "organization_id": 10002,
        "default_group_id": 98738
      }
    }
  }
}

The event contains the following unique properties in the user_event object:

  • previous - The previous numerical value
  • current - The current numerical value

Custom Field Changed - Integer

An event where the value of an integer custom field is changed.

Example

{
  "version": "0",
  "id": "7369d9e1-8b2c-4b05-a813-e66d76b8d8f1",
  "detail-type": "Support User: Custom Field Changed",
  "source": "aws.partner/zendesk.com/9242270/default",
  "account": "123456789012",
  "time": "2020-01-25T01:23:48Z",
  "region": "us-east-1",
  "resources": ["Support User"],
  "detail": {
    "user_event": {
      "meta": {
        "version": "1.0",
        "occurred_at": "2020-01-25T01:23:45Z",
        "ref": "1-1234567890",
        "sequence": {
          "id": "0572B2EE0A2B22E5EE8BB107928D7E6D",
          "position": 3,
          "total": 7
        }
      },
      "type": "Custom Field Changed",
      "custom_field": {
        "id": 1234,
        "title": "Integer",
        "field_type": "integer"
      },
      "previous": "10",
      "current": "100",
      "user": {
        "id": 35436,
        "external_id": "SF12345",
        "role": "agent",
        "email": "[email protected]",
        "created_at": "2020-01-20T22:50:29Z",
        "updated_at": "2020-01-25T01:23:45Z",
        "organization_id": 10002,
        "default_group_id": 98738
      }
    }
  }
}

The event contains the following unique properties in the user_event object:

  • previous - The previous numerical value
  • current - The current numerical value

Custom Field Changed - Regex

An event where the value of a regex custom field is changed.

Example

{
  "version": "0",
  "id": "7369d9e1-8b2c-4b05-a813-e66d76b8d8f1",
  "detail-type": "Support User: Custom Field Changed",
  "source": "aws.partner/zendesk.com/9242270/default",
  "account": "123456789012",
  "time": "2020-01-25T01:23:48Z",
  "region": "us-east-1",
  "resources": ["Support User"],
  "detail": {
    "user_event": {
      "meta": {
        "version": "1.0",
        "occurred_at": "2020-01-25T01:23:45Z",
        "ref": "1-1234567890",
        "sequence": {
          "id": "0572B2EE0A2B22E5EE8BB107928D7E6D",
          "position": 4,
          "total": 7
        }
      },
      "type": "Custom Field Changed",
      "custom_field": {
        "id": 1234,
        "title": "Regex Field",
        "field_type": "regexp"
      },
      "previous": null,
      "current": "http://example.com",
      "user": {
        "id": 35436,
        "external_id": "SF12345",
        "role": "agent",
        "email": "[email protected]",
        "created_at": "2020-01-20T22:55:29Z",
        "updated_at": "2020-01-25T01:23:45Z",
        "organization_id": 10002,
        "default_group_id": 98738
      }
    }
  }
}

The event contains the following unique properties in the user_event object:

  • previous - The previous regex value
  • current - The current regex value

Custom Field Changed - Tagger

An event where the value of a tagger custom field is changed.

Example

 {
   "version": "0",
   "id": "7369d9e1-8b2c-4b05-a813-e66d76b8d8f1",
   "detail-type": "Support User: Custom Field Changed",
   "source": "aws.partner/zendesk.com/9242270/default",
   "account": "123456789012",
   "time": "2020-01-25T01:23:48Z",
   "region": "us-east-1",
   "resources": ["Support User"],
   "detail": {
     "user_event": {
       "meta": {
         "version": "1.0",
         "occurred_at": "2020-01-25T01:23:45Z",
         "ref": "1-1234567890",
         "sequence": {
           "id": "0572B2EE0A2B22E5EE8BB107928D7E6D",
           "position": 5,
           "total": 7
         }
       },
       "type": "Custom Field Changed",
       "custom_field": {
         "id": 1234,
         "title": "Dropdown Field",
         "field_type": "tagger"
       },
       "previous": "choice_1",
       "current": "choice_2",
       "user": {
         "id": 35436,
         "external_id": "SF12345",
         "role": "agent",
         "email": "[email protected]",
         "created_at": "2020-01-20T22:55:29Z",
         "updated_at": "2020-01-25T01:23:45Z",
         "organization_id": 10002,
         "default_group_id": 98738
       }
     }
   }
 }

The event contains the following unique properties in the user_event object:

  • previous - The previous string value
  • current - The current string value

Custom Field Changed - Text

An event where the value of a text custom field is changed.

Example

{
  "version": "0",
  "id": "7369d9e1-8b2c-4b05-a813-e66d76b8d8f1",
  "detail-type": "Support User: Custom Field Changed",
  "source": "aws.partner/zendesk.com/9242270/default",
  "account": "123456789012",
  "time": "2020-01-25T01:23:48Z",
  "region": "us-east-1",
  "resources": ["Support User"],
  "detail": {
    "user_event": {
      "meta": {
        "version": "1.0",
        "occurred_at": "2020-01-25T01:23:45Z",
        "ref": "1-1234567890",
        "sequence": {
          "id": "0572B2EE0A2B22E5EE8BB107928D7E6D",
          "position": 6,
          "total": 7
        }
      },
      "type": "Custom Field Changed",
      "custom_field": {
        "id": 1234,
        "title": "Text Field",
        "field_type": "text"
      },
      "previous": null,
      "current": "Text Message",
      "user": {
        "id": 35436,
        "external_id": "SF12345",
        "role": "agent",
        "email": "[email protected]",
        "created_at": "2020-01-20T22:55:29Z",
        "updated_at": "2020-01-25T01:23:45Z",
        "organization_id": 10002,
        "default_group_id": 98738
      }
    }
  }
}

The event contains the following unique properties in the user_event object:

  • previous - The previous string value
  • current - The current string value

Custom Field Changed - Text Area

An event where the value of a multiline text custom field is changed.

Example

{
  "version": "0",
  "id": "7369d9e1-8b2c-4b05-a813-e66d76b8d8f1",
  "detail-type": "Support User: Custom Field Changed",
  "source": "aws.partner/zendesk.com/9242270/default",
  "account": "123456789012",
  "time": "2020-01-25T01:23:48Z",
  "region": "us-east-1",
  "resources": ["Support User"],
  "detail": {
    "user_event": {
      "meta": {
        "version": "1.0",
        "occurred_at": "2020-01-25T01:23:45Z",
        "ref": "1-1234567890",
        "sequence": {
          "id": "0572B2EE0A2B22E5EE8BB107928D7E6D",
          "position": 7,
          "total": 7
        }
      },
      "type": "Custom Field Changed",
      "custom_field": {
        "id": 1234,
        "title": "MultiLine",
        "field_type": "textarea"
      },
      "previous": "This is a\nmultiline message.\nHello there.",
      "current": "This is a\nmultiline message.",
      "user": {
        "id": 35436,
        "external_id": "SF12345",
        "role": "agent",
        "email": "[email protected]",
        "created_at": "2020-01-20T22:55:29Z",
        "updated_at": "2020-01-25T01:23:45Z",
        "organization_id": 10002,
        "default_group_id": 98738
      }
    }
  }
}

The event contains the following unique properties in the user_event object:

  • previous - The previous multiline text
  • current - The current multiline text

Custom Role Changed

An event when the custom role of the user has changed

Example

{
  "version": "0",
  "id": "31187aa5-67d2-4eea-a921-38535bf6ec3b",
  "detail-type": "Support User: Custom Role Changed",
  "source": "aws.partner/zendesk.com/9242270/default",
  "account": "123456789012",
  "time": "2020-01-21T22:55:31Z",
  "region": "us-east-1",
  "resources": ["Support User"],
  "detail": {
    "user_event": {
      "meta": {
        "version": "1.0",
        "occurred_at": "2020-01-21T22:55:29Z",
        "ref": "1-1234567890",
        "sequence": {
          "id": "35D52F7D44640033CCCE4A5F1ADDB2AA",
          "position": 1,
          "total": 7
        }
      },
      "type": "Custom Role Changed",
      "previous": null,
      "current": 43210,
      "user": {
        "id": 35436,
        "external_id": "SF12345",
        "role": "agent",
        "email": "[email protected]",
        "created_at": "2020-01-20T22:55:29Z",
        "updated_at": "2020-01-21T22:55:29Z",
        "organization_id": 10002,
        "default_group_id": 98738,
        "tags": [
          "enterprise"
        ]
      }
    }
  }
}

The event contains the following unique properties in the user_event object:

  • previous - The previous permission set ID of user's custom role
  • current - The current permission set ID of user's custom role

Default Group Changed

The following example shows an event when user's default group changed.

Example

{
  "version": "0",
  "id": "31187aa5-67d2-4eea-a921-38535bf6ec3b",
  "detail-type": "Support User: Default Group Changed",
  "source": "aws.partner/zendesk.com/9242270/default",
  "account": "123456789012",
  "time": "2020-01-25T22:55:31Z",
  "region": "us-east-1",
  "resources": ["Support User"],
  "detail": {
    "user_event": {
      "meta": {
        "version": "1.0",
        "occurred_at": "2020-01-25T22:55:29Z",
        "ref": "1-1234567890",
        "sequence": {
          "id": "35D52F7D44640033CCCE4A5F1ADDB2AA",
          "position": 5,
          "total": 9
        }
      },
      "type": "Default Group Changed",
      "previous": 98738,
      "current": 96543,
      "user": {
        "id": 35436,
        "external_id": "SF12345",
        "role": "agent",
        "email": "[email protected]",
        "created_at": "2020-01-20T22:55:29Z",
        "updated_at": "2020-01-25T22:55:29Z",
        "organization_id": 10002,
        "default_group_id": 96543
      }
    }
  }
}

The event contains the following unique properties in the user_event object:

  • previous - The previous default group ID
  • current - The current default group ID

Details Changed

The following example shows an event when the user details changed.

Example

{
  "version": "0",
  "id": "31187aa5-67d2-4eea-a921-38535bf6ec3b",
  "detail-type": "Support User: Details Changed",
  "source": "aws.partner/zendesk.com/9242270/default",
  "account": "123456789012",
  "time": "2020-01-20T22:55:31Z",
  "region": "us-east-1",
  "resources": ["Support User"],
  "detail": {
    "user_event": {
      "meta": {
        "version": "1.0",
        "occurred_at": "2020-01-20T22:55:29Z",
        "ref": "1-1234567890",
        "sequence": {
          "id": "35D52F7D44640033CCCE4A5F1ADDB2AA",
          "position": 5,
          "total": 9
        }
      },
      "type": "Details Changed",
      "previous": "user old details",
      "current": "new details",
      "user": {
        "id": 35436,
        "external_id": "SF12345",
        "role": "agent",
        "email": "[email protected]",
        "created_at": "2020-01-20T22:55:29Z",
        "updated_at": "2020-01-20T22:55:29Z",
        "organization_id": 10002,
        "default_group_id": 98738
      }
    }
  }
}

The event contains the following unique properties in the user_event object:

  • previous - The previous user details
  • current - The current user details

External ID Changed

An event when user's external ID changed.

Example

{
  "version": "0",
  "id": "31187aa5-67d2-4eea-a921-38535bf6ec3b",
  "detail-type": "Support User: External ID Changed",
  "source": "aws.partner/zendesk.com/9242270/default",
  "account": "123456789012",
  "time": "2020-01-25T22:55:31Z",
  "region": "us-east-1",
  "resources": ["Support User"],
  "detail": {
    "user_event": {
      "meta": {
        "version": "1.0",
        "occurred_at": "2020-01-25T22:55:29Z",
        "ref": "1-1234567890",
        "sequence": {
          "id": "35D52F7D44640033CCCE4A5F1ADDB2AA",
          "position": 6,
          "total": 9
        }
      },
      "type": "External ID Changed",
      "previous": "SF123456",
      "current": "AU123456",
      "user": {
        "id": 35436,
        "external_id": "AU123456",
        "role": "agent",
        "email": "[email protected]",
        "created_at": "2020-01-20T22:55:29Z",
        "updated_at": "2020-01-25T22:55:29Z",
        "organization_id": 10002,
        "default_group_id": 98738
      }
    }
  }
}

The event contains the following unique properties in the user_event object:

  • previous - Previous external ID of the user
  • current - Current external ID of the user

Group Added

An event when a group is added to the user.

Example

{
  "version": "0",
  "id": "31187aa5-67d2-4eea-a921-38535bf6ec3b",
  "detail-type": "Support User: Group Added",
  "source": "aws.partner/zendesk.com/9242270/default",
  "account": "123456789012",
  "time": "2020-01-20T22:55:31Z",
  "region": "us-east-1",
  "resources": ["Support User"],
  "detail": {
    "user_event": {
      "meta": {
        "version": "1.0",
        "occurred_at": "2020-01-20T22:55:29Z",
        "ref": "1-1234567890",
        "sequence": {
          "id": "35D52F7D44640033CCCE4A5F1ADDB2AA",
          "position": 1,
          "total": 2
        }
      },
      "type": "Group Added",
      "group_added": 98738,
      "user": {
        "id": 35436,
        "external_id": "SF12345",
        "role": "agent",
        "email": "[email protected]",
        "created_at": "2020-01-20T22:55:29Z",
        "updated_at": "2020-01-20T22:55:29Z",
        "organization_id": 10002,
        "default_group_id": 98738,
        "tags": [
          "enterprise"
        ]
      }
    }
  }
}

In the user_event object, group_added is the ID of the group which has been added to the user.

Group Removed

An event when a group is removed from the user.

Example

{
  "version": "0",
  "id": "31187aa5-67d2-4eea-a921-38535bf6ec3b",
  "detail-type": "Support User: Group Removed",
  "source": "aws.partner/zendesk.com/9242270/default",
  "account": "123456789012",
  "time": "2020-01-20T22:55:31Z",
  "region": "us-east-1",
  "resources": ["Support User"],
  "detail": {
    "user_event": {
      "meta": {
        "version": "1.0",
        "occurred_at": "2020-01-20T22:55:29Z",
        "ref": "1-1234567890",
        "sequence": {
          "id": "35D52F7D44640033CCCE4A5F1ADDB2AA",
          "position": 2,
          "total": 2
        }
      },
      "type": "Group Removed",
      "group_removed": 98738,
      "user": {
        "id": 35436,
        "external_id": "SF12345",
        "role": "agent",
        "email": "[email protected]",
        "created_at": "2020-01-20T22:55:29Z",
        "updated_at": "2020-01-20T22:55:29Z",
        "organization_id": 10002,
        "default_group_id": null,
        "tags": [
          "enterprise"
        ]
      }
    }
  }
}

In the user_event object, group_removed is the ID of the group that has been removed from the user

Identity Changed

An event when user's identity changed.

Example

{
  "version": "0",
  "id": "31187aa5-67d2-4eea-a921-38535bf6ec3b",
  "detail-type": "Support User: Identity Changed",
  "source": "aws.partner/zendesk.com/9242270/default",
  "account": "123456789012",
  "time": "2020-01-25T22:55:31Z",
  "region": "us-east-1",
  "resources": ["Support User"],
  "detail": {
    "user_event": {
      "meta": {
        "version": "1.0",
        "occurred_at": "2020-01-25T22:55:29Z",
        "ref": "1-1234567890",
        "sequence": {
          "id": "35D52F7D44640033CCCE4A5F1ADDB2AA",
          "position": 8,
          "total": 9
        }
      },
      "type": "Identity Changed",
      "previous": {
        "id": 12345,
        "identity_type": "email",
        "value": "[email protected]",
        "primary": false
      },
      "current": {
        "id": 12345,
        "identity_type": "email",
        "value": "[email protected]",
        "primary": true
      },
      "user": {
        "id": 35436,
        "external_id": "SF12345",
        "role": "agent",
        "email": "[email protected]",
        "created_at": "2020-01-20T22:55:29Z",
        "updated_at": "2020-01-25T22:55:29Z",
        "organization_id": 10002,
        "default_group_id": 98738
      }
    }
  }
}

The event contains the following unique properties in the user_event object: - previous - The previous user identity - current - The current user identity

Identity Created

An event when the user's identity has been created.

Example

{
  "version": "0",
  "id": "31187aa5-67d2-4eea-a921-38535bf6ec3b",
  "detail-type": "Support User: Identity Created",
  "source": "aws.partner/zendesk.com/9242270/default",
  "account": "123456789012",
  "time": "2020-01-25T22:55:31Z",
  "region": "us-east-1",
  "resources": ["Support User"],
  "detail": {
    "user_event": {
      "meta": {
        "version": "1.0",
        "occurred_at": "2020-01-25T22:55:29Z",
        "ref": "1-1234567890",
        "sequence": {
          "id": "35D52F7D44640033CCCE4A5F1ADDB2AA",
          "position": 7,
          "total": 9
        }
      },
      "type": "Identity Created",
      "identity": {
        "id": 12345,
        "identity_type": "email",
        "value": "[email protected]",
        "primary": true
      },
      "user": {
        "id": 35436,
        "external_id": "SF12345",
        "role": "agent",
        "email": "[email protected]",
        "created_at": "2020-01-20T22:55:29Z",
        "updated_at": "2020-01-25T22:55:29Z",
        "organization_id": 10002,
        "default_group_id": 98738
      }
    }
  }
}

The identity object contains properties which matches the User Identity API. For more information, see User Identities API.

Identity Deleted

An event when the user's identity has been deleted.

Example

{
  "version": "0",
  "id": "31187aa5-67d2-4eea-a921-38535bf6ec3b",
  "detail-type": "Support User: Identity Deleted",
  "source": "aws.partner/zendesk.com/9242270/default",
  "account": "123456789012",
  "time": "2020-01-25T22:55:31Z",
  "region": "us-east-1",
  "resources": ["Support User"],
  "detail": {
    "user_event": {
      "meta": {
        "version": "1.0",
        "occurred_at": "2020-01-25T22:55:29Z",
        "ref": "1-1234567890",
        "sequence": {
          "id": "35D52F7D44640033CCCE4A5F1ADDB2AA",
          "position": 9,
          "total": 9
        }
      },
      "type": "Identity Deleted",
      "identity_id": 12345,
      "user": {
        "id": 35436,
        "external_id": "SF12345",
        "role": "agent",
        "email": "[email protected]",
        "created_at": "2020-01-20T22:55:29Z",
        "updated_at": "2020-01-25T22:55:29Z",
        "organization_id": 10002,
        "default_group_id": 98738
      }
    }
  }
}

In the user_event object, the identity_id property is the ID automatically assigned to the identity when it's created in Support.

Last Login Changed

An event when the user's last login time changed.

Example

{
  "version": "0",
  "id": "31187aa5-67d2-4eea-a921-38535bf6ec3b",
  "detail-type": "Support User: Last Login Changed",
  "source": "aws.partner/zendesk.com/9242270/default",
  "account": "123456789012",
  "time": "2020-01-25T22:55:31Z",
  "region": "us-east-1",
  "resources": ["Support User"],
  "detail": {
    "user_event": {
      "meta": {
        "version": "1.0",
        "occurred_at": "2020-01-25T22:55:29Z",
        "ref": "1-1234567890",
        "sequence": {
          "id": "35D52F7D44640033CCCE4A5F1ADDB2AA",
          "position": 3,
          "total": 9
        }
      },
      "type": "Last Login Changed",
      "previous": "2020-01-16T16:17:54Z",
      "current": "2020-01-25T22:55:29Z",
      "user": {
        "id": 35436,
        "external_id": "SF12345",
        "role": "agent",
        "email": "[email protected]",
        "created_at": "2020-01-20T22:55:29Z",
        "updated_at": "2020-01-25T22:55:29Z",
        "organization_id": 10002,
        "default_group_id": 98738
      }
    }
  }
}

The event contains the following unique properties in the user_event object:

  • previous - The previous login date and time of the user
  • current - The current login date and time of the user

Locale Changed

An event when the Locale of the user is changed.

Example

{
  "version": "0",
  "id": "31187aa5-67d2-4eea-a921-38535bf6ec3b",
  "detail-type": "Support User: Locale Changed",
  "source": "aws.partner/zendesk.com/9242270/default",
  "account": "123456789012",
  "time": "2020-01-20T22:55:31Z",
  "region": "us-east-1",
  "resources": ["Support User"],
  "detail": {
    "user_event": {
      "meta": {
        "version": "1.0",
        "occurred_at": "2020-01-20T22:55:29Z",
        "ref": "1-1234567890",
        "sequence": {
          "id": "35D52F7D44640033CCCE4A5F1ADDB2AA",
          "position": 2,
          "total": 9
        }
      },
      "type": "Locale Changed",
      "previous": "en-us",
      "current": "en-au",
      "user": {
        "id": 35436,
        "external_id": "SF12345",
        "role": "agent",
        "email": "[email protected]",
        "created_at": "2020-01-20T22:55:29Z",
        "updated_at": "2020-01-20T22:55:29Z",
        "organization_id": 10002,
        "default_group_id": 98738
      }
    }
  }
}

The event contains the following unique properties in the user_event object:

  • previous - The previous locale
  • current - The current locale

Name Changed

An event when the name of a Support user is changed.

Example

{
  "version": "0",
  "id": "31187aa5-67d2-4eea-a921-38535bf6ec3b",
  "detail-type": "Support User: Name Changed",
  "source": "aws.partner/zendesk.com/9242270/default",
  "account": "123456789012",
  "time": "2020-01-20T22:55:31Z",
  "region": "us-east-1",
  "resources": ["Support User"],
  "detail": {
    "user_event": {
      "meta": {
        "version": "1.0",
        "occurred_at": "2020-01-20T22:55:29Z",
        "ref": "1-1234567890",
        "sequence": {
          "id": "35D52F7D44640033CCCE4A5F1ADDB2AA",
          "position": 2,
          "total": 9
        }
      },
      "type": "Name Changed",
      "previous": null,
      "current": "abc",
      "user": {
        "id": 35436,
        "external_id": "SF12345",
        "role": "agent",
        "email": "[email protected]",
        "created_at": "2020-01-20T22:55:29Z",
        "updated_at": "2020-01-20T22:55:29Z",
        "organization_id": 10002,
        "default_group_id": 98738
      }
    }
  }
}

The event contains the following unique properties in the user_event object:

  • previous - The previous user name
  • current - The current user name

Notes Changed

An event when the notes of a Support user is changed.

Example

{
  "version": "0",
  "id": "31187aa5-67d2-4eea-a921-38535bf6ec3b",
  "detail-type": "Support User: Notes Changed",
  "source": "aws.partner/zendesk.com/9242270/default",
  "account": "123456789012",
  "time": "2020-01-20T22:55:31Z",
  "region": "us-east-1",
  "resources": ["Support User"],
  "detail": {
    "user_event": {
      "meta": {
        "version": "1.0",
        "occurred_at": "2020-01-20T22:55:29Z",
        "ref": "1-1234567890",
        "sequence": {
          "id": "35D52F7D44640033CCCE4A5F1ADDB2AA",
          "position": 6,
          "total": 9
        }
      },
      "type": "Notes Changed",
      "previous": "old notes",
      "current": "new notes",
      "user": {
        "id": 35436,
        "external_id": "SF12345",
        "role": "agent",
        "email": "[email protected]",
        "created_at": "2020-01-20T22:55:29Z",
        "updated_at": "2020-01-20T22:55:29Z",
        "organization_id": 10002,
        "default_group_id": 98738
      }
    }
  }
}

The event contains the following unique properties in the user_event object:

  • previous - The previous user notes
  • current - The current user notes

Only Private Comments Changed

An event when only private comments status of the user is changed.

Example

{
  "version": "0",
  "id": "31187aa5-67d2-4eea-a921-38535bf6ec3b",
  "detail-type": "Support User: Only Private Comments Changed",
  "source": "aws.partner/zendesk.com/9242270/default",
  "account": "123456789012",
  "time": "2020-01-25T22:55:31Z",
  "region": "us-east-1",
  "resources": ["Support User"],
  "detail": {
    "user_event": {
      "meta": {
        "version": "1.0",
        "occurred_at": "2020-01-25T22:55:29Z",
        "ref": "1-1234567890",
        "sequence": {
          "id": "35D52F7D44640033CCCE4A5F1ADDB2AA",
          "position": 2,
          "total": 9
        }
      },
      "type": "Only Private Comments Changed",
      "previous": false,
      "current": true,
      "user": {
        "id": 35436,
        "external_id": "SF12345",
        "role": "agent",
        "email": "[email protected]",
        "created_at": "2020-01-20T22:55:29Z",
        "updated_at": "2020-01-25T22:55:29Z",
        "organization_id": 10002,
        "default_group_id": 98738
      }
    }
  }
}

The event contains the following unique properties in the user_event object:

  • previous - The previous boolean value of only private comments for the user
  • current - The current boolean value of only private comments for the user

Organization Added

An event when organization is added to the user.

Example

{
  "version": "0",
  "id": "31187aa5-67d2-4eea-a921-38535bf6ec3b",
  "detail-type": "Support User: Organization Added",
  "source": "aws.partner/zendesk.com/9242270/default",
  "account": "123456789012",
  "time": "2020-01-20T22:55:31Z",
  "region": "us-east-1",
  "resources": ["Support User"],
  "detail": {
    "user_event": {
      "meta": {
        "version": "1.0",
        "occurred_at": "2020-01-20T22:55:29Z",
        "ref": "1-1234567890",
        "sequence": {
          "id": "35D52F7D44640033CCCE4A5F1ADDB2AA",
          "position": 2,
          "total": 9
        }
      },
      "type": "Organization Added",
      "organization_added": 10002,
      "user": {
        "id": 35436,
        "external_id": "SF12345",
        "role": "agent",
        "email": "[email protected]",
        "created_at": "2020-01-20T22:55:29Z",
        "updated_at": "2020-01-20T22:55:29Z",
        "organization_id": 10002,
        "default_group_id": 98738
      }
    }
  }
}

In the user_event object, organization_added is the ID of the organization which has been added to the user.

Organization Removed

An event when an organization is removed from the user.

Example

{
  "version": "0",
  "id": "31187aa5-67d2-4eea-a921-38535bf6ec3b",
  "detail-type": "Support User: Organization Removed",
  "source": "aws.partner/zendesk.com/9242270/default",
  "account": "123456789012",
  "time": "2020-01-20T22:55:31Z",
  "region": "us-east-1",
  "resources": ["Support User"],
  "detail": {
    "user_event": {
      "meta": {
        "version": "1.0",
        "occurred_at": "2020-01-20T22:55:29Z",
        "ref": "1-1234567890",
        "sequence": {
          "id": "35D52F7D44640033CCCE4A5F1ADDB2AA",
          "position": 2,
          "total": 9
        }
      },
      "type": "Organization Removed",
      "organization_removed": 10002,
      "user": {
        "id": 35436,
        "external_id": "SF12345",
        "role": "agent",
        "email": "[email protected]",
        "created_at": "2020-01-20T22:55:29Z",
        "updated_at": "2020-01-20T22:55:29Z",
        "organization_id": null,
        "default_group_id": 98738
      }
    }
  }
}

In the user_event object, organization_removed is the ID of the organization that has been removed from the user

Photo Changed

An event when the photo of a Support user is changed.

Example

{
  "version": "0",
  "id": "31187aa5-67d2-4eea-a921-38535bf6ec3b",
  "detail-type": "Support User: Photo Changed",
  "source": "aws.partner/zendesk.com/9242270/default",
  "account": "123456789012",
  "time": "2020-01-20T22:55:31Z",
  "region": "us-east-1",
  "resources": ["Support User"],
  "detail": {
    "user_event": {
      "meta": {
        "version": "1.0",
        "occurred_at": "2020-01-20T22:55:29Z",
        "ref": "1-1234567890",
        "sequence": {
          "id": "35D52F7D44640033CCCE4A5F1ADDB2AA",
          "position": 3,
          "total": 9
        }
      },
      "type": "Photo Changed",
      "previous": "http://example.com/original.jpg",
      "current": "http://example.com/current.jpg",
      "user": {
        "id": 35436,
        "external_id": "SF12345",
        "role": "agent",
        "email": "[email protected]",
        "created_at": "2020-01-20T22:55:29Z",
        "updated_at": "2020-01-20T22:55:29Z",
        "organization_id": 10002,
        "default_group_id": 98738
      }
    }
  }
}

The event contains the following unique properties in the user_event object:

  • previous - The previous photo url
  • current - The current photo url

Role Changed

An event when the role of the user has changed

Example

{
  "version": "0",
  "id": "31187aa5-67d2-4eea-a921-38535bf6ec3b",
  "detail-type": "Support User: Role Changed",
  "source": "aws.partner/zendesk.com/9242270/default",
  "account": "123456789012",
  "time": "2020-01-20T22:55:31Z",
  "region": "us-east-1",
  "resources": ["Support User"],
  "detail": {
    "user_event": {
      "meta": {
        "version": "1.0",
        "occurred_at": "2020-01-20T22:55:29Z",
        "ref": "1-1234567890",
        "sequence": {
          "id": "35D52F7D44640033CCCE4A5F1ADDB2AA",
          "position": 4,
          "total": 7
        }
      },
      "type": "Role Changed",
      "previous": "admin",
      "current": "agent",
      "user": {
        "id": 35436,
        "external_id": "SF12345",
        "role": "agent",
        "email": "[email protected]",
        "created_at": "2020-01-20T22:55:29Z",
        "updated_at": "2020-01-20T22:55:29Z",
        "organization_id": 10002,
        "default_group_id": 98738,
        "tags": [
          "enterprise"
        ]
      }
    }
  }
}

The event contains the following unique properties in the user_event object:

  • previous - The previous role of the user
  • current - The current role of the user

Tags Changed

An event when tags on the Support user is changed.

Example

{
  "version": "0",
  "id": "31187aa5-67d2-4eea-a921-38535bf6ec3b",
  "detail-type": "Support User: Tags Changed",
  "source": "aws.partner/zendesk.com/9242270/default",
  "account": "123456789012",
  "time": "2020-01-20T22:55:31Z",
  "region": "us-east-1",
  "resources": ["Support User"],
  "detail": {
    "user_event": {
      "meta": {
        "version": "1.0",
        "occurred_at": "2020-01-20T22:55:29Z",
        "ref": "1-1234567890",
        "sequence": {
          "id": "35D52F7D44640033CCCE4A5F1ADDB2AA",
          "position": 7,
          "total": 9
        }
      },
      "type": "Tags Changed",
      "tags_added": ["chat"],
      "tags_removed": ["talk"],
      "user": {
        "id": 35436,
        "external_id": "SF12345",
        "role": "agent",
        "email": "[email protected]",
        "created_at": "2020-01-20T22:55:29Z",
        "updated_at": "2020-01-20T22:55:29Z",
        "organization_id": 10002,
        "default_group_id": 98738
      }
    }
  }
}

The event contains the following unique properties in the user_event object:

  • tags_added - Tags added to the user
  • tags_removed - Tags removed from the user

Time Zone Changed

An event when time zone of the Support user is changed.

Example

{
  "version": "0",
  "id": "31187aa5-67d2-4eea-a921-38535bf6ec3b",
  "detail-type": "Support User: Time Zone Changed",
  "source": "aws.partner/zendesk.com/9242270/default",
  "account": "123456789012",
  "time": "2020-01-25T22:55:31Z",
  "region": "us-east-1",
  "resources": ["Support User"],
  "detail": {
    "user_event": {
      "meta": {
        "version": "1.0",
        "occurred_at": "2020-01-25T22:55:29Z",
        "ref": "1-1234567890",
        "sequence": {
          "id": "35D52F7D44640033CCCE4A5F1ADDB2AA",
          "position": 4,
          "total": 9
        }
      },
      "type": "Time Zone Changed",
      "previous": "American Samoa",
      "current": "Pacific Time (US & Canada)",
      "user": {
        "id": 35436,
        "external_id": "SF12345",
        "role": "agent",
        "email": "[email protected]",
        "created_at": "2020-01-20T22:55:29Z",
        "updated_at": "2020-01-25T22:55:29Z",
        "organization_id": 10002,
        "default_group_id": 98738
      }
    }
  }
}

The event contains the following unique properties in the user_event object:

  • previous - The previous time zone of the user
  • current - The current time zone of the user

User Created

An event when a Support user is created.

Example

{
  "version": "0",
  "id": "31187aa5-67d2-4eea-a921-38535bf6ec3b",
  "detail-type": "Support User: User Created",
  "source": "aws.partner/zendesk.com/9242270/default",
  "account": "123456789012",
  "time": "2020-01-20T22:55:31Z",
  "region": "us-east-1",
  "resources": ["Support User"],
  "detail": {
    "user_event": {
      "meta": {
        "version": "1.0",
        "occurred_at": "2020-01-20T22:55:29Z",
        "ref": "1-1234567890",
        "sequence": {
          "id": "35D52F7D44640033CCCE4A5F1ADDB2AA",
          "position": 1,
          "total": 9
        }
      },
      "type": "User Created",
      "user": {
        "id": 35436,
        "external_id": "SF12345",
        "role": "agent",
        "email": "[email protected]",
        "created_at": "2020-01-20T22:55:29Z",
        "updated_at": "2020-01-20T22:55:29Z",
        "organization_id": 10002,
        "default_group_id": 98738
      }
    }
  }
}

User Merged

An event when a Support user is merged.

Example

{
  "version": "0",
  "id": "31187aa5-67d2-4eea-a921-38535bf6ec3b",
  "detail-type": "Support User: User Merged",
  "source": "aws.partner/zendesk.com/9242270/default",
  "account": "123456789012",
  "time": "2020-01-20T22:55:31Z",
  "region": "us-east-1",
  "resources": ["Support User"],
  "detail": {
    "user_event": {
      "meta": {
        "version": "1.0",
        "occurred_at": "2020-01-20T22:55:29Z",
        "ref": "1-1234567890",
        "sequence": {
          "id": "35D52F7D44640033CCCE4A5F1ADDB2AA",
          "position": 2,
          "total": 9
        }
      },
      "type": "User Merged",
      "target_user_id": 12345,
      "user": {
        "id": 35436,
        "external_id": "SF12345",
        "role": "agent",
        "email": "[email protected]",
        "created_at": "2020-01-20T22:55:29Z",
        "updated_at": "2020-01-20T22:55:29Z",
        "organization_id": 10002,
        "default_group_id": 98738
      }
    }
  }
}

The event contains the property target_user_id, which is the ID of the user that the user has been merged into.