TicketResponse
{
"type": "object",
"properties": {
"ticket": {
"$ref": "#/components/schemas/TicketObject"
}
}
}
TicketSkipCreation
{
"type": "object",
"properties": {
"skip": {
"$ref": "#/components/schemas/TicketSkipObject"
}
}
}
TicketSkipObject
{
"type": "object",
"example": {
"id": 1,
"reason": "I have no idea.",
"ticket": {
"id": 123,
"url": "https://company.zendesk.com/api/v2/tickets/35436.json",
"via": {
"channel": "web"
},
"tags": [
"enterprise",
"other_tag"
],
"type": "incident",
"due_at": null,
"status": "open",
"subject": "Help, my printer is on fire!",
"group_id": 98738,
"priority": "high",
"recipient": "support@company.com",
"created_at": "2009-07-20T22:55:29Z",
"problem_id": 9873764,
"updated_at": "2011-05-05T10:38:52Z",
"assignee_id": 235323,
"description": "The fire is very colorful.",
"external_id": "ahg35h3jh",
"raw_subject": "{{dc.printer_on_fire}}",
"follower_ids": [
35334,
234
],
"requester_id": 20978392,
"submitter_id": 76872,
"custom_fields": [
{
"id": 27642,
"value": "745"
},
{
"id": 27648,
"value": "yes"
}
],
"has_incidents": false,
"organization_id": 509974,
"collaborator_ids": [
35334,
234
],
"satisfaction_rating": {
"id": 1234,
"score": "good",
"comment": "Great support!"
},
"sharing_agreement_ids": [
84432
],
"from_messaging_channel": false
},
"user_id": 456,
"ticket_id": 123,
"created_at": "2015-09-30T21:44:03Z",
"updated_at": "2015-09-30T21:44:03Z"
},
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"description": "Automatically assigned upon creation"
},
"reason": {
"type": "string",
"readOnly": true,
"description": "Reason for skipping the ticket"
},
"ticket": {
"$ref": "#/components/schemas/TicketObject"
},
"user_id": {
"type": "integer",
"readOnly": true,
"description": "ID of the skipping agent"
},
"ticket_id": {
"type": "integer",
"readOnly": true,
"description": "ID of the skipped ticket"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "Time the skip was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "Time the skip was last updated"
}
},
"x-konfig-properties": {
"ticket": {
"type": "object",
"description": "The skipped ticket. See the [Ticket object reference](/api-reference/ticketing/tickets/tickets/#json-format)"
}
}
}
TicketSkipsResponse
{
"type": "object",
"properties": {
"skips": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TicketSkipObject"
}
}
}
}
TicketUpdateInput
{
"type": "object",
"example": {
"comment": {
"body": "The smoke is very colorful."
},
"subject": "My printer is on fire!",
"priority": "urgent"
},
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The array of tags applied to this ticket"
},
"type": {
"enum": [
"problem",
"incident",
"question",
"task"
],
"type": "string",
"description": "The type of this ticket."
},
"due_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "If this is a ticket of type \"task\" it has a due date. Due date format uses [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format."
},
"status": {
"enum": [
"new",
"open",
"pending",
"hold",
"solved",
"closed"
],
"type": "string",
"description": "The state of the ticket.\n\nIf your account has activated custom ticket statuses, this is the ticket's\nstatus category. See [custom ticket statuses](https://developer.zendesk.com).\n"
},
"comment": {
"$ref": "#/components/schemas/TicketCommentObject"
},
"subject": {
"type": "string",
"description": "The value of the subject field for this ticket"
},
"group_id": {
"type": "integer",
"description": "The group this ticket is assigned to"
},
"priority": {
"enum": [
"urgent",
"high",
"normal",
"low"
],
"type": "string",
"description": "The urgency with which the ticket should be addressed."
},
"email_ccs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailCCObject"
},
"description": "An array of objects that represent agent or end users email CCs to add or delete from the ticket. See [Setting email CCs](/documentation/ticketing/managing-tickets/creating-and-updating-tickets#setting-email-ccs)"
},
"followers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FollowerObject"
},
"description": "An array of objects that represent agent followers to add or delete from the ticket. See [Setting followers](/documentation/ticketing/managing-tickets/creating-and-updating-tickets#setting-followers)"
},
"problem_id": {
"type": "integer",
"description": "For tickets of type \"incident\", the ID of the problem the incident is linked to"
},
"assignee_id": {
"type": "integer",
"description": "The agent currently assigned to the ticket"
},
"external_id": {
"type": "string",
"description": "An id you can use to link Zendesk Support tickets to local records"
},
"safe_update": {
"type": "boolean",
"description": "Optional boolean. Prevents updates with outdated ticket data (`updated_stamp` property required when true)"
},
"requester_id": {
"type": "integer",
"description": "The user who requested this ticket"
},
"custom_fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldObject"
},
"description": "Custom fields for the ticket. See [Setting custom field values](/documentation/ticketing/managing-tickets/creating-and-updating-tickets#setting-custom-field-values)"
},
"updated_stamp": {
"type": "string",
"format": "date-time",
"description": "Datetime of last update received from API. See the safe_update property"
},
"assignee_email": {
"type": "string",
"format": "email",
"description": "The email address of the agent to assign the ticket to"
},
"organization_id": {
"type": "integer",
"description": "The organization of the requester. You can only specify the ID of an organization associated with the requester. See [Organization Memberships](https://developer.zendesk.com)"
},
"collaborator_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The ids of users currently CC'ed on the ticket"
},
"custom_status_id": {
"type": "integer",
"description": "The custom ticket status id of the ticket. See [custom ticket statuses](https://developer.zendesk.com)"
},
"attribute_value_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "An array of the IDs of attribute values to be associated with the ticket"
},
"sharing_agreement_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "An array of the numeric IDs of sharing agreements. Note that this replaces any existing agreements"
},
"additional_collaborators": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollaboratorObject"
},
"description": "An array of numeric IDs, emails, or objects containing name and email properties. See [Setting Collaborators](/api-reference/ticketing/tickets/tickets/#setting-collaborators). An email notification is sent to them when the ticket is updated"
}
}
}
TicketUpdateRequest
{
"type": "object",
"properties": {
"ticket": {
"$ref": "#/components/schemas/TicketUpdateInput"
}
}
}
TicketUpdateResponse
{
"type": "object",
"properties": {
"audit": {
"$ref": "#/components/schemas/AuditObject"
},
"ticket": {
"$ref": "#/components/schemas/TicketObject"
}
}
}
TicketsAutocompleteProblemsRequest
{
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "The text to search for"
}
}
}
TicketsCountTicketsResponse
{
"type": "object",
"properties": {
"count": {
"type": "object",
"properties": {
"value": {
"type": "integer"
},
"refreshed_at": {
"type": "string",
"format": "date-time"
}
}
}
}
}
TicketsCreateRequest
{
"type": "object",
"properties": {
"tickets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TicketCreateInput"
}
}
}
}
TicketsMarkAsSpamAndSuspendRequesterResponse
{
"type": "string",
"example": ""
}
TicketsResponse
{
"type": "object",
"properties": {
"tickets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TicketObject"
}
}
}
}
TicketsRestoreBulkTicketsResponse
{
"type": "string",
"example": "",
"description": "Empty response"
}
TicketsRestoreTicketResponse
{
"type": "string",
"example": "",
"description": "Empty response"
}
TimeBasedExportIncrementalTicketsResponse
{
"type": "object",
"example": {
"count": 2,
"tickets": [
{
"id": 35436,
"url": "https://company.zendesk.com/api/v2/tickets/35436.json",
"via": {
"channel": "web"
},
"tags": [
"enterprise",
"other_tag"
],
"type": "incident",
"due_at": null,
"status": "open",
"subject": "Help, my printer is on fire!",
"group_id": 98738,
"priority": "high",
"recipient": "support@company.com",
"created_at": "2009-07-20T22:55:29Z",
"problem_id": 9873764,
"updated_at": "2011-05-05T10:38:52Z",
"assignee_id": 235323,
"description": "The fire is very colorful.",
"external_id": "ahg35h3jh",
"raw_subject": "{{dc.printer_on_fire}}",
"follower_ids": [
35334,
234
],
"requester_id": 20978392,
"submitter_id": 76872,
"custom_fields": [
{
"id": 27642,
"value": "745"
},
{
"id": 27648,
"value": "yes"
}
],
"has_incidents": false,
"organization_id": 509974,
"collaborator_ids": [
35334,
234
],
"satisfaction_rating": {
"id": 1234,
"score": "good",
"comment": "Great support!"
},
"sharing_agreement_ids": [
84432
]
}
],
"end_time": 1390362485,
"next_page": "https://{subdomain}.zendesk.com/api/v2/incremental/tickets.json?per_page=3&start_time=1390362485",
"end_of_stream": true
},
"properties": {
"count": {
"type": "integer"
},
"tickets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TicketObject"
}
},
"end_time": {
"type": "integer"
},
"next_page": {
"type": "string",
"nullable": true
},
"end_of_stream": {
"type": "boolean"
}
},
"description": "See [Tickets](https://developer.zendesk.com) for a detailed example.\n"
}
TimeBasedExportIncrementalUsersResponse
{
"type": "object",
"example": {
"count": 1,
"users": [
{
"id": 35436,
"url": "https://company.zendesk.com/api/v2/users/35436.json",
"name": "Johnny Agent",
"role": "agent",
"tags": [
"enterprise",
"other_tag"
],
"alias": "Mr. Johnny",
"email": "johnny@example.com",
"notes": "Johnny is a nice guy!",
"phone": "+15551234567",
"photo": {
"id": 928374,
"name": "my_funny_profile_pic.png",
"size": 166144,
"thumbnails": [
{
"id": 928375,
"name": "my_funny_profile_pic_thumb.png",
"size": 58298,
"content_url": "https://company.zendesk.com/photos/my_funny_profile_pic_thumb.png",
"content_type": "image/png"
}
],
"content_url": "https://company.zendesk.com/photos/my_funny_profile_pic.png",
"content_type": "image/png"
},
"active": true,
"locale": "en-US",
"shared": false,
"details": "",
"verified": true,
"locale_id": 1,
"moderator": true,
"role_type": 0,
"signature": "Have a nice day, Johnny",
"suspended": true,
"time_zone": "Copenhagen",
"created_at": "2009-07-20T22:55:29Z",
"updated_at": "2011-05-05T10:38:52Z",
"external_id": "sai989sur98w9",
"user_fields": {
"user_date": "2012-07-23T00:00:00Z",
"user_decimal": 5.1,
"user_dropdown": "option_1"
},
"shared_agent": false,
"last_login_at": "2011-05-05T10:38:52Z",
"custom_role_id": 9373643,
"organization_id": 57542,
"restricted_agent": true,
"ticket_restriction": "assigned",
"only_private_comments": false
}
],
"end_time": 1601357503,
"next_page": "https://example.zendesk.com/api/v2/incremental/ticket_events.json?start_time=1601357503",
"end_of_stream": true
},
"properties": {
"count": {
"type": "integer"
},
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserObject"
}
},
"end_time": {
"type": "integer"
},
"next_page": {
"type": "string",
"nullable": true
},
"end_of_stream": {
"type": "boolean"
}
}
}
TrialAccountObject
{
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL of the account"
},
"name": {
"type": "string",
"description": "The name of the account"
},
"subdomain": {
"type": "string",
"description": "The subdomain of the account"
}
}
}
TrialAccountResponse
{
"type": "object",
"properties": {
"account": {
"$ref": "#/components/schemas/TrialAccountObject"
}
}
}
TriggerActionDefinitionObject
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"group": {
"type": "string"
},
"title": {
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"value": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
}
}
},
"subject": {
"type": "string"
},
"nullable": {
"type": "boolean"
},
"repeatable": {
"type": "boolean"
}
}
}
TriggerActionDiffObject
{
"type": "object",
"example": {
"field": [
{
"change": "+",
"content": "solved"
}
],
"value": [
{
"change": "-",
"content": "open"
}
]
},
"properties": {
"field": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TriggerChangeObject"
},
"description": "An array of [change](https://developer.zendesk.com) objects."
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TriggerChangeObject"
},
"description": "An array of [change](https://developer.zendesk.com) objects."
}
}
}
TriggerActionObject
{
"type": "object",
"example": {
"field": "status",
"value": "solved"
},
"properties": {
"field": {
"type": "string"
},
"value": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "array",
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
}
]
}
}
}
TriggerBatchRequest
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string"
},
"active": {
"type": "boolean"
},
"position": {
"type": "integer",
"format": "int64"
},
"category_id": {
"type": "string"
}
}
}
TriggerBulkUpdateItem
{
"type": "object",
"example": {
"id": 25,
"active": true,
"position": 8,
"category_id": "10026"
},
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"description": "The ID of the trigger to update"
},
"active": {
"type": "boolean",
"description": "The active status of the trigger (true or false)"
},
"position": {
"type": "integer",
"description": "The new position of the trigger"
},
"category_id": {
"type": "string",
"description": "The ID of the new category the trigger is to be moved to"
}
}
}
TriggerBulkUpdateRequest
{
"type": "object",
"properties": {
"triggers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TriggerBulkUpdateItem"
}
}
}
}
TriggerCategoriesCreateCategoryRequest
{
"type": "object",
"properties": {
"trigger_category": {
"allOf": [
{
"$ref": "#/components/schemas/TriggerCategoryRequest"
},
{
"$ref": "#/components/schemas/TriggerCategoryRequestRequired"
}
]
}
}
}
TriggerCategoriesGetListResponse
{
"allOf": [
{
"$ref": "#/components/schemas/TriggerCategoriesResponse"
},
{
"$ref": "#/components/schemas/Pagination"
}
]
}
TriggerCategoriesResponse
{
"type": "object",
"properties": {
"trigger_categories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TriggerCategory"
}
}
}
}
TriggerCategoriesUpdateCategoryByIdRequest
{
"type": "object",
"properties": {
"trigger_category": {
"$ref": "#/components/schemas/TriggerCategoryRequest"
}
}
}
TriggerCategory
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string"
},
"position": {
"type": "integer",
"format": "int64"
},
"created_at": {
"type": "string",
"readOnly": true
},
"updated_at": {
"type": "string",
"readOnly": true
}
}
}
TriggerCategoryBatchRequest
{
"type": "object",
"required": [
"id",
"position"
],
"properties": {
"id": {
"type": "string"
},
"position": {
"type": "integer",
"format": "int64"
}
}
}
TriggerCategoryId
{
"type": "string"
}
TriggerCategoryRequest
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"position": {
"type": "integer",
"format": "int64"
}
}
}
TriggerCategoryRequestRequired
{
"type": "object",
"required": [
"name"
]
}
TriggerCategoryResponse
{
"type": "object",
"properties": {
"trigger_category": {
"$ref": "#/components/schemas/TriggerCategory"
}
}
}
TriggerCategoryRuleCounts
{
"type": "object",
"properties": {
"active_count": {
"type": "integer",
"format": "int64"
},
"inactive_count": {
"type": "integer",
"format": "int64"
}
}
}
TriggerChangeObject
{
"type": "object",
"example": {
"change": "+",
"content": "solved"
},
"properties": {
"change": {
"type": "string",
"description": "One of `-`, `+`, `=` representing the type of change"
},
"content": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "array",
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
}
]
}
}
],
"description": "The value of the item it represents"
}
}
}
TriggerConditionDefinitionObjectAll
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"group": {
"type": "string"
},
"title": {
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"value": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
}
}
},
"subject": {
"type": "string"
},
"nullable": {
"type": "boolean"
},
"operators": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"value": {
"type": "string"
},
"terminal": {
"type": "boolean"
}
}
}
},
"repeatable": {
"type": "boolean"
}
}
}
TriggerConditionDefinitionObjectAny
{
"type": "object",
"properties": {
"type": {
"type": "string"
},
"group": {
"type": "string"
},
"title": {
"type": "string"
},
"subject": {
"type": "string"
},
"nullable": {
"type": "boolean"
},
"operators": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"value": {
"type": "string"
},
"terminal": {
"type": "boolean"
}
}
}
},
"repeatable": {
"type": "boolean"
}
}
}
TriggerConditionDiffObject
{
"type": "object",
"example": {
"field": [
{
"change": "=",
"content": "status"
}
],
"value": [
{
"change": "+",
"content": "solved"
}
],
"operator": [
{
"change": "=",
"content": "less_than"
}
]
},
"properties": {
"field": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TriggerChangeObject"
},
"description": "An array of [change](https://developer.zendesk.com) objects"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TriggerChangeObject"
},
"description": "An array of [change](https://developer.zendesk.com) objects"
},
"operator": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TriggerChangeObject"
},
"description": "An array of [change](https://developer.zendesk.com) objects"
}
}
}
TriggerConditionObject
{
"type": "object",
"example": {
"field": "status",
"value": "solved",
"operator": "less_than"
},
"properties": {
"field": {
"type": "string"
},
"value": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "array",
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
}
]
},
"operator": {
"type": "string"
}
}
}
TriggerConditionsDiffObject
{
"type": "object",
"properties": {
"all": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TriggerConditionDiffObject"
},
"nullable": true
},
"any": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TriggerConditionDiffObject"
},
"nullable": true
}
}
}
TriggerConditionsObject
{
"type": "object",
"example": {
"all": [
{
"field": "status",
"value": "solved",
"operator": "less_than"
},
{
"field": "assignee_id",
"value": "296220096",
"operator": "is"
},
{
"field": "custom_status_id",
"value": [
"1",
"2"
],
"operator": "includes"
}
],
"any": [
{
"field": "status",
"value": "solved",
"operator": "less_than"
},
{
"field": "custom_status_id",
"value": [
"1",
"2"
],
"operator": "includes"
}
]
},
"properties": {
"all": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TriggerConditionObject"
},
"nullable": true
},
"any": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TriggerConditionObject"
},
"nullable": true
}
},
"description": "An object that describes the conditions under which the trigger will execute. See [Conditions reference](https://developer.zendesk.com)"
}
TriggerDefinitionObject
{
"type": "object",
"properties": {
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TriggerActionDefinitionObject"
}
},
"conditions_all": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TriggerConditionDefinitionObjectAll"
}
},
"conditions_any": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TriggerConditionDefinitionObjectAny"
}
}
}
}
TriggerDefinitionResponse
{
"type": "object",
"properties": {
"definitions": {
"$ref": "#/components/schemas/TriggerDefinitionObject"
}
}
}
TriggerObject
{
"type": "object",
"example": {
"id": 25,
"url": "http://{subdomain}.zendesk.com/api/v2/triggers/25.json",
"title": "Close and Save",
"active": true,
"actions": [
{}
],
"default": false,
"position": 8,
"raw_title": "Close and Save",
"conditions": {},
"created_at": "2012-09-25T22:50:26Z",
"updated_at": "2012-09-25T22:50:26Z",
"category_id": "10026",
"description": "Close and save a ticket"
},
"required": [
"conditions",
"actions",
"title"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"description": "Automatically assigned when created"
},
"url": {
"type": "string",
"readOnly": true,
"description": "The url of the trigger"
},
"title": {
"type": "string",
"description": "The title of the trigger"
},
"active": {
"type": "boolean",
"description": "Whether the trigger is active"
},
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TriggerActionObject"
},
"description": "An array of actions describing what the trigger will do. See [Actions reference](https://developer.zendesk.com)"
},
"default": {
"type": "boolean",
"readOnly": true,
"description": "If true, the trigger is a default trigger"
},
"position": {
"type": "integer",
"description": "Position of the trigger, determines the order they will execute in"
},
"raw_title": {
"type": "string",
"description": "The raw format of the title of the trigger"
},
"conditions": {
"$ref": "#/components/schemas/TriggerConditionsObject"
},
"created_at": {
"type": "string",
"readOnly": true,
"description": "The time the trigger was created"
},
"updated_at": {
"type": "string",
"readOnly": true,
"description": "The time of the last update of the trigger"
},
"category_id": {
"type": "string",
"description": "The ID of the category the trigger belongs to"
},
"description": {
"type": "string",
"description": "The description of the trigger"
}
}
}
TriggerResponse
{
"type": "object",
"properties": {
"trigger": {
"$ref": "#/components/schemas/TriggerObject"
}
}
}
TriggerRevisionResponse
{
"type": "object",
"properties": {
"trigger_revision": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"url": {
"type": "string"
},
"snapshot": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"active": {
"type": "boolean"
},
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TriggerActionObject"
}
},
"conditions": {
"$ref": "#/components/schemas/TriggerConditionsObject"
},
"description": {
"type": "string",
"nullable": true
}
}
},
"author_id": {
"type": "integer"
},
"created_at": {
"type": "string"
}
}
}
}
}
TriggerRevisionsResponse
{
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"after_url": {
"type": "string"
},
"before_url": {
"type": "string"
},
"after_cursor": {
"type": "string"
},
"before_cursor": {
"type": "string"
},
"trigger_revisions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"url": {
"type": "string"
},
"diff": {
"type": "object",
"properties": {
"title": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TriggerChangeObject"
},
"description": "An array of [change](https://developer.zendesk.com) objects"
},
"active": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TriggerChangeObject"
},
"description": "An array of [change](https://developer.zendesk.com) objects"
},
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TriggerActionDiffObject"
},
"description": "An array that contain [action diff objects](#Action Diffs)"
},
"source_id": {
"type": "integer",
"description": "ID of the source revision"
},
"target_id": {
"type": "integer",
"description": "ID of the target revision"
},
"conditions": {
"$ref": "#/components/schemas/TriggerConditionDiffObject"
},
"description": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TriggerChangeObject"
},
"description": "An array of [change](https://developer.zendesk.com) objects"
}
}
},
"snapshot": {
"$ref": "#/components/schemas/TriggerSnapshotObject"
},
"author_id": {
"type": "integer"
},
"created_at": {
"type": "string"
}
}
}
}
}
}
TriggerSnapshotObject
{
"type": "object",
"example": {
"title": "Notify requester of comment update",
"active": true,
"actions": [],
"conditions": {},
"description": "Notifies requester that a comment was updated"
},
"properties": {
"title": {
"type": "string",
"description": "The title of the trigger"
},
"active": {
"type": "boolean",
"description": "Whether the trigger is active"
},
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TriggerActionObject"
},
"description": "An array of [Actions](https://developer.zendesk.com) describing what the trigger will do"
},
"conditions": {
"$ref": "#/components/schemas/TriggerConditionsObject"
},
"description": {
"type": "string",
"nullable": true,
"description": "The description of the trigger"
}
}
}
TriggerWithCategoryRequest
{
"type": "object",
"properties": {
"trigger": {
"allOf": [
{
"$ref": "#/components/schemas/TriggerObject"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/TriggerCategory"
},
{
"$ref": "#/components/schemas/TriggerCategoryId"
}
]
}
]
}
}
}