SatisfactionRatingsResponse
{
"type": "object",
"properties": {
"satisfaction_ratings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SatisfactionRatingObject"
}
}
}
}
SatisfactionReasonObject
{
"type": "object",
"example": {
"id": 35436,
"url": "https://example.zendesk.com/api/v2/satisfaction_reasons/35436.json",
"value": "Agent did not respond quickly",
"raw_value": "{{dc.reason_code_1003}}",
"created_at": "2011-07-20T22:55:29Z",
"deleted_at": "2012-03-12T12:45:32Z",
"updated_at": "2011-07-20T22:55:29Z",
"reason_code": 1003
},
"required": [
"value"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"description": "Automatically assigned upon creation"
},
"url": {
"type": "string",
"readOnly": true,
"description": "API URL for the resource"
},
"value": {
"type": "string",
"description": "Translated value of the reason in the account locale"
},
"raw_value": {
"type": "string",
"description": "The dynamic content placeholder, if present, or the current \"value\", if not. See [Dynamic Content Items](https://developer.zendesk.com)"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The time the reason was created"
},
"deleted_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The time the reason was deleted"
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The time the reason was updated"
},
"reason_code": {
"type": "integer",
"readOnly": true,
"description": "An account-level code for referencing the reason. Custom reasons are assigned an auto-incrementing integer (non-system reason codes begin at 1000). See [Reason codes](https://developer.zendesk.com)"
}
}
}
SatisfactionReasonResponse
{
"type": "object",
"properties": {
"reason": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SatisfactionReasonObject"
}
}
}
}
SatisfactionReasonsResponse
{
"type": "object",
"properties": {
"reasons": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SatisfactionReasonObject"
}
}
}
}
SearchCountResponse
{
"type": "object",
"properties": {
"count": {
"type": "integer"
}
}
}
SearchExportResponse
{
"type": "object",
"example": {
"meta": {
"has_more": true,
"after_cursor": "eyJmaWVsZCI6ImNyZWF0ZWRfYXQiLCJkZXNjIjp0cnVlLCJ0aWVCcmVha0ZpZWxkIjoiaWQiLCJ0aWVCcmVha0Rlc2MiOmZhbHNlLCJzb3J0VmFsdWVzIjpudWxsLCJleHBvcnRlZFRodXNGYXIiOjAsInNlc3Npb25TdGFydCI6MTYwNzAzOTI1Mzk4NSwiY3JlYXRlZEF0IjoxNjA3MDM5MjUzOTg1LCJzYWx0ZWRSZXF1ZXN0SGFzaCI6LTQ5ODM0ODc3LCJzYWx0ZWRDdXJzb3JIYXNoIjotMjQwMzQ4MjgwfQ==",
"before_cursor": null
},
"links": {
"next": "https://example.zendesk.com/api/v2/search/export.json?filter%5Btype%5D=ticket&page%5Bafter%5D=eyJmaWVsZCI6ImNyZWF0ZWRfYXQiLCJkZXNjIjp0cnVlLCJ0aWVCcmVha0ZpZWxkIjoiaWQiLCJ0aWVCcmVha0Rlc2MiOmZhbHNlLCJzb3J0VmFsdWVzIjpudWxsLCJleHBvcnRlZFRodXNGYXIiOjAsInNlc3Npb25TdGFydCI6MTYwNzAzOTI1Mzk4NSwiY3JlYXRlZEF0IjoxNjA3MDM5MjUzOTg1LCJzYWx0ZWRSZXF1ZXN0SGFzaCI6LTQ5ODM0ODc3LCJzYWx0ZWRDdXJzb3JIYXNoIjotMjQwMzQ4MjgwfQ%3D%3D&page%5Bsize%5D=100&query=hello%26page%5Bsize%5D%3D100%26filter%5Btype%5D%3Dticket",
"prev": null
},
"facets": null,
"results": []
},
"properties": {
"meta": {
"type": "object",
"properties": {
"has_more": {
"type": "boolean",
"readOnly": true,
"description": "Whether there are more items yet to be returned by the cursor."
},
"after_cursor": {
"type": "string",
"nullable": true,
"readOnly": true,
"description": "The cursor id for the next object."
},
"before_cursor": {
"type": "string",
"nullable": true,
"readOnly": true,
"description": "The cursor id for the previous object."
}
},
"description": "Metadata for the export query response."
},
"links": {
"type": "object",
"properties": {
"next": {
"type": "string",
"nullable": true,
"readOnly": true,
"description": "The url to the next entry via the cursor."
},
"prev": {
"type": "string",
"nullable": true,
"readOnly": true,
"description": "The url to the previous entry via the cursor."
}
},
"description": "The links to the previous and next entries via the cursor ids in the metadata."
},
"facets": {
"type": "string",
"nullable": true,
"readOnly": true,
"description": "The facets corresponding to the search query"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SearchResultObject"
},
"readOnly": true,
"description": "May consist of tickets, users, groups, or organizations, as specified by the `result_type` property in each result object"
}
}
}
SearchResponse
{
"type": "object",
"example": {
"count": 1,
"facets": null,
"results": [
{
"id": 1835972,
"url": "https://example.zendesk.com/api/v2/groups/1835972.json",
"name": "Ragtail",
"default": false,
"deleted": false,
"created_at": "2018-04-06T03:17:05Z",
"updated_at": "2018-04-06T03:17:05Z",
"description": "",
"result_type": "group"
}
],
"next_page": null,
"previous_page": null
},
"properties": {
"count": {
"type": "integer",
"readOnly": true,
"description": "The number of resources returned by the query corresponding to this page of results in the paginated response"
},
"facets": {
"type": "string",
"nullable": true,
"readOnly": true,
"description": "The facets corresponding to the search query"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SearchResultObject"
},
"readOnly": true,
"description": "May consist of tickets, users, groups, or organizations, as specified by the `result_type` property in each result object"
},
"next_page": {
"type": "string",
"nullable": true,
"readOnly": true,
"description": "URL to the next page of results"
},
"previous_page": {
"type": "string",
"nullable": true,
"readOnly": true,
"description": "URL to the previous page of results"
}
}
}
SearchResultObject
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the resource"
},
"url": {
"type": "string",
"description": "The url of the resource"
},
"name": {
"type": "string",
"description": "The name of the resource"
},
"default": {
"type": "boolean",
"description": "Flag to indicate whether this is the default resource"
},
"deleted": {
"type": "boolean",
"description": "Flag to indicate whether or not resource has been deleted"
},
"created_at": {
"type": "string",
"description": "When the resource was created"
},
"updated_at": {
"type": "string",
"description": "When the resource was last updated"
},
"description": {
"type": "string",
"description": "The description of the resource"
},
"result_type": {
"type": "string",
"description": "The type of the resource"
}
}
}
SessionObject
{
"type": "object",
"example": {
"id": 3432,
"url": "https://company.zendesk.com/api/v2/users/12345/sessions/3432.json",
"user_id": 12345,
"last_seen_at": "2014-11-18T17:30:52Z",
"authenticated_at": "2014-11-18T17:24:29Z"
},
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"description": "Automatically assigned when the session is created"
},
"url": {
"type": "string",
"nullable": true,
"description": "The API URL of this session"
},
"user_id": {
"type": "integer",
"nullable": true,
"description": "The id of the user"
},
"last_seen_at": {
"type": "string",
"nullable": true,
"description": "The last approximate time this session was seen. This does not update on every request."
},
"authenticated_at": {
"type": "string",
"nullable": true,
"description": "When the session was created"
}
}
}
SessionResponse
{
"type": "object",
"properties": {
"session": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SessionObject"
}
}
}
}
SessionsResponse
{
"type": "object",
"properties": {
"sessions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SessionObject"
}
}
}
}
SharingAgreementObject
{
"type": "object",
"example": {
"id": 88335,
"url": "https://company.zendesk.com/api/v2/agreements/88335.json",
"name": "Ticket Sharing",
"type": "inbound",
"status": "accepted",
"created_at": "2012-02-20T22:55:29Z",
"updated_at": "2013-02-20T22:55:29Z",
"partner_name": "jira"
},
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"description": "Automatically assigned upon creation"
},
"url": {
"type": "string",
"readOnly": true,
"description": "URL of the sharing agreement record"
},
"name": {
"type": "string",
"description": "Name of this sharing agreement"
},
"type": {
"type": "string",
"description": "Can be one of the following: \"inbound\", \"outbound\""
},
"status": {
"type": "string",
"description": "Can be one of the following: \"accepted\", \"declined\", \"pending\", \"inactive\", \"failed\", \"ssl_error\", \"configuration_error\""
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The time the record was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The time the record was updated"
},
"partner_name": {
"type": "string",
"nullable": true,
"description": "Can be one of the following: \"jira\", null"
},
"remote_subdomain": {
"type": "string",
"description": "Subdomain of the remote account or null if not associated with an account"
}
}
}
SharingAgreementResponse
{
"type": "object",
"properties": {
"sharing_agreement": {
"$ref": "#/components/schemas/SharingAgreementObject"
}
}
}
SharingAgreementsResponse
{
"type": "object",
"properties": {
"sharing_agreements": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SharingAgreementObject"
}
}
}
}
SkillBasedRoutingAttributeDefinitions
{
"type": "object",
"properties": {
"definitions": {
"type": "object",
"properties": {
"conditions_all": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"subject": {
"type": "string"
}
}
}
},
"conditions_any": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"subject": {
"type": "string"
}
}
}
}
}
}
}
}
SkillBasedRoutingAttributeObject
{
"type": "object",
"example": {
"id": "15821cba-7326-11e8-b07e-950ba849aa27",
"url": "https://{subdomain}.zendesk.com/api/v2/routing/attributes/15821cba-7326-11e8-b07e-950ba849aa27.json",
"name": "color",
"created_at": "2017-12-01T19:29:31Z",
"updated_at": "2017-12-01T19:29:31Z"
},
"required": [
"name"
],
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "Automatically assigned when an attribute is created"
},
"url": {
"type": "string",
"readOnly": true,
"description": "URL of the attribute"
},
"name": {
"type": "string",
"description": "The name of the attribute"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When this record was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When this record was last updated"
}
}
}
SkillBasedRoutingAttributeResponse
{
"type": "object",
"properties": {
"attribute": {
"$ref": "#/components/schemas/SkillBasedRoutingAttributeObject"
}
}
}
SkillBasedRoutingAttributeValueObject
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "Automatically assigned when an attribute value is created"
},
"url": {
"type": "string",
"readOnly": true,
"description": "URL of the attribute value"
},
"name": {
"type": "string",
"description": "The name of the attribute value"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When this record was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When this record was last updated"
},
"attribute_id": {
"type": "string",
"description": "Id of the associated attribute"
}
}
}
SkillBasedRoutingAttributeValueResponse
{
"type": "object",
"properties": {
"attribute_value": {
"$ref": "#/components/schemas/SkillBasedRoutingAttributeValueObject"
}
}
}
SkillBasedRoutingAttributeValuesResponse
{
"type": "object",
"properties": {
"attribute_values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SkillBasedRoutingAttributeValueObject"
}
}
}
}
SkillBasedRoutingAttributesResponse
{
"type": "object",
"properties": {
"count": {
"type": "integer",
"readOnly": true
},
"next_page": {
"type": "string",
"nullable": true,
"readOnly": true
},
"attributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SkillBasedRoutingAttributeObject"
}
},
"previous_page": {
"type": "string",
"nullable": true,
"readOnly": true
}
}
}
SkillBasedRoutingTicketFulfilledResponse
{
"type": "object",
"properties": {
"fulfilled_ticket_ids": {
"type": "array",
"items": {
"type": "integer"
}
}
}
}
SlaPoliciesReorderSlaPoliciesResponse
{
"type": "string",
"example": "",
"description": "Empty response"
}
SupportAddressObject
{
"type": "object",
"example": {
"id": 35436,
"name": "all",
"email": "support@example.zendesk.com",
"default": true,
"brand_id": 123,
"created_at": "2015-07-20T22:55:29Z",
"spf_status": "verified",
"updated_at": "2016-09-21T20:15:20Z",
"cname_status": "verified",
"forwarding_status": "unknown",
"domain_verification_status": "verified"
},
"required": [
"email"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"description": "Automatically assigned when created"
},
"name": {
"type": "string",
"description": "The name for the address"
},
"email": {
"type": "string",
"description": "The email address. You can't change the email address of an existing support address."
},
"default": {
"type": "boolean",
"description": "Whether the address is the account's default support address"
},
"brand_id": {
"type": "integer",
"description": "The ID of the [brand](https://developer.zendesk.com)"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the address was created"
},
"spf_status": {
"enum": [
"unknown",
"verified",
"failed"
],
"type": "string",
"readOnly": true,
"description": "Whether the SPF record is set up correctly. Possible values: \"unknown\", \"verified\", \"failed\""
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the address was updated"
},
"dns_results": {
"enum": [
"verified",
"failed"
],
"type": "string",
"readOnly": true,
"description": "Verification statuses for the domain and CNAME records. Possible types: \"verified\", \"failed\""
},
"cname_status": {
"enum": [
"unknown",
"verified",
"failed"
],
"type": "string",
"readOnly": true,
"description": "Whether all of the required CNAME records are set. Possible values: \"unknown\", \"verified\", \"failed\""
},
"forwarding_status": {
"enum": [
"unknown",
"waiting",
"verified",
"failed"
],
"type": "string",
"readOnly": true,
"description": "Status of email forwarding. Possible values: \"unknown\", \"waiting\", \"verified\", or \"failed\""
},
"domain_verification_code": {
"type": "string",
"readOnly": true,
"description": "Verification string to be added as a TXT record to the domain. Possible types: string or null."
},
"domain_verification_status": {
"enum": [
"unknown",
"verified",
"failed"
],
"type": "string",
"readOnly": true,
"description": "Whether the domain verification record is valid. Possible values: \"unknown\", \"verified\", \"failed\""
}
}
}
SupportAddressResponse
{
"type": "object",
"properties": {
"recipient_address": {
"$ref": "#/components/schemas/SupportAddressObject"
}
}
}
SupportAddressesResponse
{
"type": "object",
"properties": {
"recipient_addresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SupportAddressObject"
}
}
}
}
SupportAddressesVerifyForwardingResponse
{
"type": "string",
"example": "",
"description": "Empty response"
}
SuspendedTicketObject
{
"type": "object",
"example": {
"id": 435,
"url": "https://example.zendesk.com/api/v2/tickets/35436.json",
"via": {
"source": {
"to": {
"name": "Example Account",
"address": "support@example.zendesk.com"
},
"rel": null,
"from": {
"name": "TotallyLegit",
"address": "totallylegit@emailaddress.com"
}
},
"channel": "email"
},
"cause": "Detected as spam",
"author": {
"id": 1111,
"name": "Mr. Roboto",
"email": "styx@example.com"
},
"content": "Out Of Office Reply",
"subject": "Help, my printer is on fire!",
"brand_id": 123,
"cause_id": 0,
"recipient": "john@example.com",
"ticket_id": 67321,
"created_at": "2009-07-20T22:55:29Z",
"message_id": "Spambot@spam.co.evil",
"updated_at": "2011-05-05T10:38:52Z",
"attachments": [],
"error_messages": null
},
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"description": "Automatically assigned"
},
"url": {
"type": "string",
"readOnly": true,
"description": "The API url of this ticket"
},
"via": {
"$ref": "#/components/schemas/ViaObject"
},
"cause": {
"type": "string",
"readOnly": true,
"description": "Why the ticket was suspended"
},
"author": {
"$ref": "#/components/schemas/AuthorObject"
},
"content": {
"type": "string",
"readOnly": true,
"description": "The content that was flagged"
},
"subject": {
"type": "string",
"readOnly": true,
"description": "The value of the subject field for this ticket"
},
"brand_id": {
"type": "integer",
"readOnly": true,
"description": "The id of the brand this ticket is associated with. Only applicable for Enterprise accounts"
},
"cause_id": {
"type": "integer",
"readOnly": true,
"description": "The ID of the cause"
},
"recipient": {
"type": "string",
"readOnly": true,
"description": "The original recipient e-mail address of the ticket"
},
"ticket_id": {
"type": "integer",
"readOnly": true,
"description": "The ticket ID this suspended email is associated with, if available"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The ticket ID this suspended email is associated with, if available"
},
"message_id": {
"type": "string",
"readOnly": true,
"description": "The ID of the email, if available"
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the ticket was assigned"
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AttachmentObject"
},
"nullable": true,
"readOnly": true,
"description": "The attachments, if any associated to this suspended ticket. See [Attachments](https://developer.zendesk.com)"
},
"error_messages": {
"type": "array",
"items": {
"type": "object"
},
"nullable": true,
"readOnly": true,
"description": "The error messages if any associated to this suspended ticket"
}
},
"x-konfig-properties": {
"author": {
"type": "object",
"readOnly": true,
"description": "The author id (if available), name and email"
}
}
}
SuspendedTicketResponse
{
"type": "object",
"properties": {
"suspended_ticket": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SuspendedTicketObject"
}
}
}
}
SuspendedTicketsAttachmentsResponse
{
"type": "object",
"properties": {
"upload": {
"type": "object",
"properties": {
"token": {
"type": "string",
"readOnly": true,
"description": "Token for subsequent request"
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AttachmentObject"
}
}
}
}
}
}
SuspendedTicketsExportResponse
{
"type": "object",
"properties": {
"export": {
"type": "object",
"properties": {
"status": {
"type": "string",
"readOnly": true
},
"view_id": {
"type": "string",
"readOnly": true
}
}
}
}
}
SuspendedTicketsResponse
{
"type": "object",
"properties": {
"suspended_tickets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SuspendedTicketObject"
}
}
}
}
SystemFieldOptionObject
{
"type": "object",
"properties": {
"name": {
"type": "string",
"readOnly": true,
"description": "Name of the system field option"
},
"value": {
"type": "string",
"readOnly": true,
"description": "Value of the system field option"
}
}
}
TagCountObject
{
"type": "object",
"properties": {
"value": {
"type": "integer",
"readOnly": true,
"description": "The count of tags created in the last 24 hours"
},
"refreshed_at": {
"type": "string",
"readOnly": true,
"description": "The time that the count value was last refreshed"
}
}
}
TagCountResponse
{
"type": "object",
"properties": {
"count": {
"$ref": "#/components/schemas/TagCountObject"
}
}
}
TagListTagObject
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "A name for the tag"
},
"count": {
"type": "integer",
"readOnly": true,
"description": "The number of tags"
}
}
}
TagUrlObject
{
"type": "object",
"properties": {
"url": {
"type": "string",
"readOnly": true,
"description": "The url associated to the api request"
}
}
}
TagsByObjectIdResponse
{
"type": "object",
"required": [
"tags"
],
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of strings"
}
}
}
TagsResponse
{
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagListTagObject"
}
},
"count": {
"type": "integer",
"readOnly": true,
"description": "The number of pages"
},
"next_page": {
"type": "string",
"nullable": true,
"readOnly": true,
"description": "The url of the previous page"
},
"previous_page": {
"type": "string",
"nullable": true,
"readOnly": true,
"description": "The url of the next page"
}
}
}
TargetBasecamp
{
"type": "object",
"required": [
"target_url",
"token",
"project_id",
"resource"
],
"properties": {
"token": {
"type": "string",
"description": "Get the API token from My info > Show your tokens > Token for feed readers or the Basecamp API in your Basecamp account"
},
"password": {
"type": "string",
"description": "The 37Signals password for the Basecamp account (only writable)"
},
"resource": {
"type": "string",
"description": "\"todo\" or \"message\""
},
"username": {
"type": "string",
"description": "The 37Signals username of the account you use to log in to Basecamp"
},
"message_id": {
"type": "string",
"description": "Can be filled if it is a \"message\" resource"
},
"project_id": {
"type": "string",
"description": "The ID of the project in Basecamp where updates should be pushed"
},
"target_url": {
"type": "string",
"description": "The URL of your Basecamp account, including protocol and path"
},
"todo_list_id": {
"type": "string",
"description": "Can be filled if it is a \"todo\" resource"
}
}
}
TargetCampfire
{
"type": "object",
"required": [
"subdomain",
"room",
"token"
],
"properties": {
"ssl": {
"type": "boolean"
},
"room": {
"type": "string"
},
"token": {
"type": "string"
},
"subdomain": {
"type": "string"
},
"preserve_format": {
"type": "boolean"
}
}
}
TargetClickatell
{
"type": "object",
"required": [
"username",
"password",
"api_id",
"to"
],
"properties": {
"to": {
"type": "string"
},
"from": {
"type": "string"
},
"api_id": {
"type": "string"
},
"method": {
"type": "string",
"description": "Read-only"
},
"password": {
"type": "string",
"description": "only writable"
},
"username": {
"type": "string"
},
"attribute": {
"type": "string",
"description": "Read-only"
},
"target_url": {
"type": "string",
"description": "Read-only"
},
"us_small_business_account": {
"type": "string"
}
}
}
TargetCommonFields
{
"type": "object",
"required": [
"title",
"type"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"description": "Automatically assigned when created"
},
"type": {
"type": "string",
"description": "A pre-defined target, such as \"basecamp_target\". See the additional attributes for the type that follow"
},
"title": {
"type": "string",
"description": "A name for the target"
},
"active": {
"type": "boolean",
"description": "Whether or not the target is activated"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The time the target was created"
}
}
}
TargetEmail
{
"type": "object",
"required": [
"email",
"subject"
],
"properties": {
"email": {
"type": "string"
},
"subject": {
"type": "string"
}
}
}
TargetFailureObject
{
"type": "object",
"example": {
"id": 6001326,
"url": "https://example.zendesk.com/api/v2/target_failures/6001326.json",
"created_at": "2017-09-05T10:38:52Z",
"raw_request": "GET /api/v2/tickets.json HTTP/1.1\r\nUser-Agent: Zendesk Target\r\n ...",
"status_code": 401,
"target_name": "My URL Target",
"raw_response": "HTTP/1.1 401 Unauthorized\r\nServer: nginx\r\n ...",
"consecutive_failure_count": 1
},
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"description": "The ID of the target failure"
},
"url": {
"type": "string",
"readOnly": true,
"description": "The API url of the failure record"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "Time of the failure"
},
"raw_request": {
"type": "string",
"readOnly": true,
"description": "The raw message of the target request"
},
"status_code": {
"type": "integer",
"readOnly": true,
"description": "HTTP status code of the target failure"
},
"target_name": {
"type": "string",
"readOnly": true,
"description": "Name of the target failure"
},
"raw_response": {
"type": "string",
"readOnly": true,
"description": "The raw response of the failure"
},
"consecutive_failure_count": {
"type": "integer",
"readOnly": true,
"description": "Number of times the target failed consecutively"
}
}
}
TargetFailureResponse
{
"type": "object",
"properties": {
"target_failure": {
"$ref": "#/components/schemas/TargetFailureObject"
}
}
}
TargetFailuresResponse
{
"type": "object",
"properties": {
"target_failures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TargetFailureObject"
}
}
}
}
TargetFlowdock
{
"type": "object",
"required": [
"api_token"
],
"properties": {
"api_token": {
"type": "string"
}
}
}
TargetGetSatisfaction
{
"type": "object",
"required": [
"email",
"password",
"account_name"
],
"properties": {
"email": {
"type": "string"
},
"password": {
"type": "string",
"description": "only writable"
},
"target_url": {
"type": "string"
},
"account_name": {
"type": "string"
}
}
}
TargetHTTP
{
"type": "object",
"required": [
"target_url",
"method",
"content_type"
],
"properties": {
"method": {
"type": "string",
"description": "\"get\", \"patch\", \"put\", \"post\", or \"delete\""
},
"password": {
"type": "string",
"description": "only writable"
},
"username": {
"type": "string"
},
"target_url": {
"type": "string"
},
"content_type": {
"type": "string",
"description": "\"application/json\", \"application/xml\", or \"application/x-www-form-urlencoded\""
}
}
}