Overview
Configuration is provided for establishing connections with the Zendesk service. The configuration is used in the REST Connection Manager.
Setup
Press icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
In this task, we will show you step-by-step how to create a connection to Zendesk REST API using COZYROC's REST Connection Manager.
Congratulations! You have now established a connection to your Zendesk instance.
In this guide, we will show how to read data from the Zendesk service resource using the COZYROC REST Source component.
In this guide, we will show how to write data to the Zendesk service resource using the COZYROC REST Destination component.
Configuration
Base URL address: https://[domain].zendesk.com/api/v2
.
-
The authentication uses an authorized token.
The authentication has the following user-defined parameters:
- Scope:
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://support.zendesk.com/hc/en-us/articles/203663836-Using-OAuth-authentication-with-your-application#topic_pvr_ncl_1l.
- [Read] action
-
Endpoint URL address:
/job_statuses.json
.
The result is extracted from:{{=response.job_statuses}}
.
- id
A key field. Template: ShortText.
- url
Template: ShortText.
- total
Data type: DT_I4
- progress
Data type: DT_I4
- status
Template: ShortText.
- message
Template: ShortText.
- results
Field components:
- An array.
- Contains the following components: id, title, action, errors, success, status.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/tickets.json
.
The result is extracted from:{{=response.tickets}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/tickets#list-tickets.
- [Read search] action
-
Endpoint URL address:
/search.json
.
The result is extracted from:{{=response.results}}
.The action has the following user-defined parameters:
- search: Required. Specify search query (alias for "query").
The following request parameters will be automatically processed:
-
query:
type:ticket {{=parameters.search}}
Documentation: https://developer.zendesk.com/rest_api/docs/core/search.
- [Read organization_id] action
-
Endpoint URL address:
/organizations/{{=parameters.organization_id}}/tickets.json
.
The result is extracted from:{{=response.tickets}}
.The action has the following user-defined parameters:
- organization_id: Required. Specify organization identifier to retrieve specific tickets.
- [Read requested_id] action
-
Endpoint URL address:
/users/{{=parameters.requested_id}}/tickets/requested.json
.
The result is extracted from:{{=response.tickets}}
.The action has the following user-defined parameters:
- requested_id: Required. Specify user requested identifier.
- [Read ccd_id] action
-
Endpoint URL address:
/users/{{=parameters.ccd_id}}/tickets/ccd.json
.
The result is extracted from:{{=response.tickets}}
.The action has the following user-defined parameters:
- ccd_id: Required. Specify user ccd identifier.
- [Read assigned_id] action
-
Endpoint URL address:
/users/{{=parameters.assigned_id}}/tickets/assigned.json
.
The result is extracted from:{{=response.tickets}}
.The action has the following user-defined parameters:
- assigned_id: Required. Specify user assigned identifier.
- [Read recent] action
-
Endpoint URL address:
/tickets/recent.json
.
The result is extracted from:{{=response.tickets}}
.Documentation: Retrieve recent tickets..
- [Read problem] action
-
Endpoint URL address:
/problems.json
.
The result is extracted from:{{=response.tickets}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/tickets#listing-ticket-problems.
- [Read autocomplete_problem] action
-
Endpoint URL address:
/problems/autocomplete.json
.
The result is extracted from:{{=response.tickets}}
.The action has the following user-defined parameters:
- autocomplete_problem: Required. Specify autocomplete text (alias for "text").
The following request parameters will be automatically processed:
-
text:
{{=parameters.autocomplete_problem}}
Documentation: https://developer.zendesk.com/rest_api/docs/core/tickets#autocomplete-problems.
- [Read view_id] action
-
Endpoint URL address:
/views/{{=parameters.view_id}}/tickets.json
.
The result is extracted from:{{=response.tickets}}
.The action has the following user-defined parameters:
- view_id: Required. Specify view identifier.
Documentation: https://developer.zendesk.com/rest_api/docs/core/views#getting-tickets-from-a-view.
- [Create] action
-
Endpoint URL address:
/tickets/create_many.json
.
The result is extracted from:{{=undefined}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ tickets: batch } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/tickets#create-many-tickets.
-
application/json:
- [Update] action
-
Endpoint URL address:
/tickets/update_many.json
.
The result is extracted from:{{=undefined}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ tickets: batch } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/tickets#update-many-tickets.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/tickets/destroy_many.jso
.
The result is extracted from:{{=undefined}}
.The following request parameters will be automatically processed:
-
ids:
{{=_.pluck(batch, 'id').join()}}
Documentation: https://developer.zendesk.com/rest_api/docs/core/tickets#bulk-delete-tickets.
-
ids:
The resource includes the fields from the TicketT template.
- [External]
-
The external fields URL address:
/ticket_fields.json
. The external fields list is extracted from:{{=_.filter(response.ticket_fields, function(item) { return item.removable; })}}
.- custom_fields.{{=external.id}}
Data type: {{=Zendesk.getDataType(external.type)}} ( length {{=255}} )
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/requests.json
.
The result is extracted from:{{=response.requests}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/requests#list-requests.
- [Read open] action
-
Endpoint URL address:
/requests/open.json
.
The result is extracted from:{{=response.requests}}
.
- [Read solved] action
-
Endpoint URL address:
/requests/solved.json
.
The result is extracted from:{{=response.requests}}
.
- [Read ccd] action
-
Endpoint URL address:
/requests/ccd.json
.
The result is extracted from:{{=response.requests}}
.
- [Read user_id] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/requests.json
.
The result is extracted from:{{=response.requests}}
.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
- [Read organization_id] action
-
Endpoint URL address:
/organizations/{{=parameters.organization_id}}/requests.json
.
The result is extracted from:{{=response.requests}}
.The action has the following user-defined parameters:
- organization_id: Required. Specify organization identifier.
- [Read search] action
-
Endpoint URL address:
/requests/search.json
.
The result is extracted from:{{=response.requests}}
.The action has the following user-defined parameters:
- search: Required. Specify search query (alias for "query").
The following request parameters will be automatically processed:
-
query:
{{=parameters.search}}
Documentation: https://developer.zendesk.com/rest_api/docs/core/requests#search-requests.
- [Create] action
-
Endpoint URL address:
/requests.json
.
The result is extracted from:{{=response.request}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ request: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/requests#create-request.
-
application/json:
- [Update] action
-
Endpoint URL address:
/requests/{{=item.id}}.json
.
The result is extracted from:{{=response.request}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ request: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/requests#update-request.
-
application/json:
- id
A key field. Data type: DT_I4
- url
Template: ShortText. A read-only field.
- subject
Template: ShortText.
- description
Template: LongText.
- status
Template: ShortText.
- priority
Template: ShortText.
- type
Template: ShortText.
- custom_fields
Template: LongText. A composite field.
- organization_id
Template: ShortText. A read-only field.
- requester_id
Template: ShortText. A read-only field.
- assignee_id
Template: ShortText. A read-only field.
- group_id
Template: ShortText. A read-only field.
- collaborator_ids
Template: LongText. A read-only field. A composite field.
- via
Template: Via. A read-only field.
- is_public
Data type: DT_BOOL A read-only field.
- due_at
Template: DateTime.
- can_be_solved_by_me
Data type: DT_BOOL A read-only field.
- solved
Data type: DT_BOOL
- ticket_form_id
Data type: DT_I4
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- recipient
Template: ShortText.
- followup_source_id
Data type: DT_I4 A read-only field.
- via_followup_source_id
Data type: DT_I4
- requester
Template: Requester.
- [Delete] action
-
Endpoint URL address:
/attachments/{{=item.id}}.json
.Documentation: https://developer.zendesk.com/rest_api/docs/core/attachments#delete-attachment.
The resource includes the fields from the Attachment template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/satisfaction_ratings.json
.
The result is extracted from:{{=response.satisfaction_ratings}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/satisfaction_ratings#list-satisfaction-ratings.
- [Create] action
-
Endpoint URL address:
/tickets/{{=item.ticket_id}}/satisfaction_rating.json
.
The result is extracted from:{{=response.satisfaction_rating}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/satisfaction_ratings#create-a-satisfaction-rating.
- id
A key field. Data type: DT_I4
- url
Template: ShortText. A read-only field.
- assignee_id
Template: ShortText. A read-only field.
- group_id
Template: ShortText. A read-only field.
- requester_id
Template: ShortText. A read-only field.
- ticket_id
Data type: DT_I4
- score
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- comment
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/satisfaction_reasons.json
.
The result is extracted from:{{=response.reasons}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/satisfaction_reasons#list-reasons-for-satisfaction-rating.
- id
A key field. Data type: DT_I4
- url
Template: ShortText. A read-only field.
- reason_code
Data type: DT_I4 A read-only field.
- value
Template: ShortText.
- raw_value
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- deleted_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/suspended_tickets.json
.
The result is extracted from:{{=response.suspended_tickets}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/suspended_tickets#list-suspended-tickets.
- [Delete] action
-
Endpoint URL address:
/suspended_tickets/destroy_many.json
.The following request parameters will be automatically processed:
-
ids:
{{=_.pluck(batch, 'id').join()}}
Documentation: https://developer.zendesk.com/rest_api/docs/core/suspended_tickets#delete-multiple-suspended-tickets.
-
ids:
- id
A key field. Data type: DT_I4
- url
Template: ShortText. A read-only field.
- author
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, name, email.
-
Uses template:
- subject
Template: ShortText.
- content
Template: LongText.
- cause
Template: ShortText.
- message_id
Template: ShortText.
- ticket_id
Data type: DT_I4
- recipient
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- via
Template: Via. A read-only field.
- brand_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/tickets/{{=parameters.ticket_id}}/audits.json
.
The result is extracted from:{{=response.audits}}
.The action has the following user-defined parameters:
- ticket_id: Required. Specify ticket identifier.
Documentation: https://developer.zendesk.com/rest_api/docs/core/ticket_audits#list-audits-for-a-ticket.
- id
A key field. Data type: DT_I4
- ticket_id
Data type: DT_I4
- metadata
Template: LongText. A composite field.
- via
Template: Via.
- created_at
Template: DateTime.
- author_id
Data type: DT_I4
- events
Field components:
- An array.
- Contains the following components: id, type, subject, body, html_body, public, attachments, via, value, previous_value, field_name, comment_id, attachment_id, data, formatted_from, formatted_to, transcription_visible, trusted, recipients, score, assignee_id, agreement_id, action, message, direct_message, page, communication, ticket_via, author_id, graph_object_id, resource, value_reference.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/tickets/{{=parameters.ticket_id}}/comments.json
.
The result is extracted from:{{=response.comments}}
.The action has the following user-defined parameters:
- ticket_id: Required. Specify ticket identifier.
Documentation: https://developer.zendesk.com/rest_api/docs/core/ticket_comments#list-comments.
- id
A key field. Data type: DT_I4
- type
Template: ShortText. A read-only field.
- body
Template: LongText.
- html_body
Template: LongText.
- plain_body
Template: LongText. A read-only field.
- public
Data type: DT_BOOL
- author_id
Data type: DT_I4
- attachments
A read-only field. Field components:
- An array.
-
Uses template:
Attachment
.
- via
Template: Via. A read-only field.
- metadata
Template: LongText. A read-only field. A composite field.
- created_at
Template: DateTime. A read-only field.
- ticket_id
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/skips.json
.
The result is extracted from:{{=response.skips}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/ticket_skips#list-skips-for-the-current-account.
- [Read ticket_id] action
-
Endpoint URL address:
/tickets/{{=parameters.ticket_id}}/skips.json
.
The result is extracted from:{{=response.skips}}
.The action has the following user-defined parameters:
- ticket_id: Required. Specify ticket identifier.
- [Read user_id] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/skips.json
.
The result is extracted from:{{=response.skips}}
.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
- [Create] action
-
Endpoint URL address:
/skips.json
.
The result is extracted from:{{=response.skip}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ skip: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/ticket_skips#record-a-new-skip-for-the-current-user.
-
application/json:
- id
A key field. Data type: DT_I4
- ticket_id
Data type: DT_I4
- user_id
Data type: DT_I4
- reason
Template: ShortText.
- ticket
Template: TicketT. A read-only field.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/ticket_metrics.json
.
The result is extracted from:{{=response.ticket_metrics}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/ticket_metrics#listing-ticket-metrics.
- [Read ticket_id] action
-
Endpoint URL address:
/tickets/{{=parameters.ticket_id}}/metrics.json
.
The result is extracted from:{{=response.ticket_metrics}}
.The action has the following user-defined parameters:
- ticket_id: Required. Specify ticket identifier.
- id
A key field. Data type: DT_I4
- ticket_id
Data type: DT_I4
- url
Template: ShortText.
- group_stations
Data type: DT_I4
- assignee_stations
Data type: DT_I4
- reopens
Data type: DT_I4
- replies
Data type: DT_I4
- assignee_updated_at
Template: DateTime.
- requester_updated_at
Template: DateTime.
- status_updated_at
Template: DateTime.
- initially_assigned_at
Template: DateTime.
- assigned_at
Template: DateTime.
- solved_at
Template: DateTime.
- latest_comment_added_at
Template: DateTime.
- first_resolution_time_in_minutes
Template: TimeInMinutes.
- reply_time_in_minutes
Template: TimeInMinutes.
- full_resolution_time_in_minutes
Template: TimeInMinutes.
- agent_wait_time_in_minutes
Template: TimeInMinutes.
- requester_wait_time_in_minutes
Template: TimeInMinutes.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/incremental/ticket_metric_events.json
.
The result is extracted from:{{=response.ticket_metric_events}}
.
The result is paginated.The action has the following user-defined parameters:
- start_time: Required. Specify start time to retrieve events.
Documentation: https://developer.zendesk.com/rest_api/docs/core/ticket_metric_events#list-ticket-metric-events.
- id
A key field. Data type: DT_I4
- ticket_id
Data type: DT_I4
- metric
Template: ShortText.
- instance_id
Data type: DT_I4
- type
Template: ShortText.
- time
Template: DateTime.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- sla
Field components:
- Contains the following components: target, business_hours, policy.
- status
Template: TimeInMinutes.
- deleted
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/users.json
.
The result is extracted from:{{=response.users}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/users#list-users.
- [Read group_id] action
-
Endpoint URL address:
/groups/{{=parameters.group_id}}/users.json
.
The result is extracted from:{{=response.users}}
.The action has the following user-defined parameters:
- group_id: Required. Specify group identifier.
- [Read organization_id] action
-
Endpoint URL address:
/organizations/{{=parameters.organization_id}}/users.json
.
The result is extracted from:{{=response.users}}
.The action has the following user-defined parameters:
- organization_id: Required. Specify organization identifier.
- [Read search] action
-
Endpoint URL address:
/users/search.json
.
The result is extracted from:{{=response.users}}
.The action has the following user-defined parameters:
- search: Required. Specify search query (alias for "query").
The following request parameters will be automatically processed:
-
query:
{{=parameters.search}}
Documentation: https://developer.zendesk.com/rest_api/docs/core/users#search-users.
- [Read autocomplete] action
-
Endpoint URL address:
/users/autocomplete.json
.
The result is extracted from:{{=response.users}}
.The action has the following user-defined parameters:
- autocomplete: Required. Specify autocomplete name (alias for "name").
The following request parameters will be automatically processed:
-
name:
{{=parameters.autocomplete}}
Documentation: https://developer.zendesk.com/rest_api/docs/core/users#autocomplete-users.
- [Create] action
-
Endpoint URL address:
/users/create_many.json
.
The result is extracted from:{{=undefined}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ users: batch } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/users#create-many-users.
-
application/json:
- [Update] action
-
Endpoint URL address:
/users/update_many.json
.
The result is extracted from:{{=undefined}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ users: batch } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/users#update-many-users.
-
application/json:
- [Upsert] action
-
Endpoint URL address:
/users/create_or_update_many.json
.
The result is extracted from:{{=undefined}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ users: batch } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/users#create-or-update-many-users.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/users/destroy_many.json
.The following request parameters will be automatically processed:
-
ids:
{{=_.pluck(batch, 'id').join()}}
Documentation: https://developer.zendesk.com/rest_api/docs/core/users#bulk-deleting-users.
-
ids:
The resource includes the fields from the UserT template.
- related
The value is gathered from
/users/{{=item.id}}/related.json
address. The gathered value is processed with{{=response.user_related}}
expression. Field components:- Contains the following components: assigned_tickets, requested_tickets, ccd_tickets, organization_subscriptions, topics, topic_comments, votes, subscriptions, entry_subscriptions, forum_subscriptions.
- [External]
-
The external fields URL address:
/user_fields.json
. The external fields list is extracted from:{{=response.user_fields}}
.- user_fields.{{=external.key}}
Data type: {{=Zendesk.getDataType(external.type)}} ( length {{=255}} )
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/identities.json
.
The result is extracted from:{{=response.identities}}
.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier for which you want to retrieve identities.
Documentation: https://developer.zendesk.com/rest_api/docs/core/user_identities#list-identities.
- [Create] action
-
Endpoint URL address:
/users/{{=item.user_id}}/identities.json
.
The result is extracted from:{{=response.identity}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ identity: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/user_identities#create-identity.
-
application/json:
- [Update] action
-
Endpoint URL address:
/api/v2/users/{{=item.user_id}}/identities/{{=item.id}}.json
.
The result is extracted from:{{=response.identity}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ identity: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/user_identities#update-identity.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/users/{{=item.user_id}}/identities/{{=item.id}}.json
.Documentation: https://developer.zendesk.com/rest_api/docs/core/user_identities#delete-identity.
- id
A key field. Data type: DT_I4
- url
Template: ShortText. A read-only field.
- user_id
A key field. Data type: DT_I4
- type
Template: ShortText. A read-only field.
- value
Template: ShortText. A read-only field.
- verified
Data type: DT_BOOL
- primary
Data type: DT_BOOL
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- undeliverable_count
Data type: DT_I4 A read-only field.
- deliverable_state
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/custom_roles.json
.
The result is extracted from:{{=response.custom_roles}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/custom_roles#list-custom-roles.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- description
Template: LongText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- configuration
Field components:
-
Uses template:
ShortText
. - Contains the following components: chat_access, end_user_profile, forum_access, forum_access_restricted_content, macro_access, manage_business_rules, manage_dynamic_content, manage_extensions_and_channels, manage_facebook, organization_editing, report_access, ticket_access, ticket_comment_access, ticket_deletion, ticket_editing, ticket_merge, ticket_tag_editing, twitter_search_access, view_access, user_view_access.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/groups.json
.
The result is extracted from:{{=response.groups}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/groups#list-groups.
- [Read user_id] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/groups.json
.
The result is extracted from:{{=response.groups}}
.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
- [Read assignable] action
-
Endpoint URL address:
/groups/assignable.json
.
The result is extracted from:{{=response.groups}}
.Documentation: Retrieve available assignable groups..
- [Create] action
-
Endpoint URL address:
/groups.json
.
The result is extracted from:{{=response.group}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ group: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/groups#create-groups.
-
application/json:
- [Update] action
-
Endpoint URL address:
/groups/{{=item.id}}.json
.
The result is extracted from:{{=response.group}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ group: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/groups#update-groups.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/groups/{{=item.id}}.json
.Documentation: https://developer.zendesk.com/rest_api/docs/core/groups#delete-group.
- id
A key field. Data type: DT_I4
- url
Template: ShortText. A read-only field.
- name
Template: ShortText.
- deleted
Data type: DT_BOOL A read-only field.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/group_memberships.json
.
The result is extracted from:{{=response.group_memberships}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/group_memberships#list-memberships.
- [Read user_id] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/group_memberships.json
.
The result is extracted from:{{=response.group_memberships}}
.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
- [Read group_id] action
-
Endpoint URL address:
/groups/{{=parameters.group_id}}/memberships.json
.
The result is extracted from:{{=response.group_memberships}}
.The action has the following user-defined parameters:
- group_id: Required. Specify group identifier.
- [Read assignable] action
-
Endpoint URL address:
/group_memberships/assignable.json
.
The result is extracted from:{{=response.group_memberships}}
.Documentation: Retrieve assignable memberships..
- [Read assignable_group_id] action
-
Endpoint URL address:
/groups/{{=parameters.assignable_group_id}}/memberships/assignable.json
.
The result is extracted from:{{=response.group_memberships}}
.The action has the following user-defined parameters:
- assignable_group_id: Required. Specify assignable group identifier.
- [Create] action
-
Endpoint URL address:
/group_memberships/create_many.json
.
The result is extracted from:{{=undefined}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ group_memberships: batch } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/group_memberships#bulk-create-memberships.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/group_memberships/destroy_many.json
.
The result is extracted from:{{=undefined}}
.The following request parameters will be automatically processed:
-
ids:
{{=_.pluck(batch, 'id').join()}}
Documentation: https://developer.zendesk.com/rest_api/docs/core/group_memberships#bulk-delete-memberships.
-
ids:
- id
A key field. Data type: DT_I4
- url
Template: ShortText. A read-only field.
- user_id
Data type: DT_I4
- group_id
Template: ShortText.
- default
Data type: DT_BOOL
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/sessions.json
.
The result is extracted from:{{=response.sessions}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/sessions#list-sessions.
- [Read user_id] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/sessions.json
.
The result is extracted from:{{=response.sessions}}
.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
- [Delete] action
-
Endpoint URL address:
/users/{{=item.user_id}}/sessions/{{=item.id}}.json
.Documentation: https://developer.zendesk.com/rest_api/docs/core/sessions#delete-session.
- id
A key field. Data type: DT_I4
- url
Template: ShortText.
- user_id
A key field. Template: ShortText.
- authenticated_at
Template: DateTime.
- last_seen_at
Template: DateTime.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/organizations.json
.
The result is extracted from:{{=response.organizations}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/organizations#list-organizations.
- [Read user_id] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/organizations.json
.
The result is extracted from:{{=response.organizations}}
.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
- [Read autocomplete] action
-
Endpoint URL address:
/organizations/autocomplete.json
.
The result is extracted from:{{=response.organizations}}
.The action has the following user-defined parameters:
- autocomplete: Required. Specify autocomplete name (alias for "name").
The following request parameters will be automatically processed:
-
name:
{{=parameters.autocomplete}}
Documentation: https://developer.zendesk.com/rest_api/docs/core/organizations#autocomplete-organizations.
- [Read external_id] action
-
Endpoint URL address:
/organizations/search.json?external_id={{=parameters.external_id}}
.
The result is extracted from:{{=response.organizations}}
.The action has the following user-defined parameters:
- external_id: Required. Specify external identifier.
Documentation: https://developer.zendesk.com/rest_api/docs/core/organizations#search-organizations-by-external-id.
- [Create] action
-
Endpoint URL address:
/organizations/create_many.json
.
The result is extracted from:{{=undefined}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ organizations: batch } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/organizations#create-many-organizations.
-
application/json:
- [Update] action
-
Endpoint URL address:
/organizations/update_many.json
.
The result is extracted from:{{=undefined}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ organizations: batch } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/organizations#update-organization.
-
application/json:
- [Upsert] action
-
Endpoint URL address:
/organizations/create_or_update.json
.
The result is extracted from:{{=response.organization}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ organization: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/organizations#create-or-update-organization.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/organizations/destroy_many.json
.
The result is extracted from:{{=undefined}}
.The following request parameters will be automatically processed:
-
ids:
{{=_.pluck(batch, 'id').join()}}
Documentation: https://developer.zendesk.com/rest_api/docs/core/organizations#bulk-delete-organizations.
-
ids:
- id
A key field. Data type: DT_I4
- url
Template: ShortText. A read-only field.
- external_id
Template: ShortText.
- name
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- domain_names
Template: LongText. A composite field.
- details
Template: LongText.
- notes
Template: LongText.
- group_id
Template: ShortText.
- shared_tickets
Data type: DT_BOOL
- shared_comments
Data type: DT_BOOL
- tags
Template: LongText. A composite field.
- related
The value is gathered from
/organizations/{{=item.id}}/related.json
address. Field components:- Contains the following components: users_count, tickets_count.
- [External]
-
The external fields URL address:
/organization_fields.json
. The external fields list is extracted from:{{=response.organization_fields}}
.- organization_fields.{{=external.key}}
Data type: {{=Zendesk.getDataType(external.type)}} ( length {{=255}} )
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/organization_subscriptions.json
.
The result is extracted from:{{=response.organization_subscriptions}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/organization_subscriptions#list-organization-subscriptions.
- [Read organization_id] action
-
Endpoint URL address:
/organizations/{{=parameters.organization_id}}/subscriptions.json
.
The result is extracted from:{{=response.organization_subscriptions}}
.The action has the following user-defined parameters:
- organization_id: Required. Specify organization identifier.
- [Read user_id] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/organization_subscriptions.json
.
The result is extracted from:{{=response.organization_subscriptions}}
.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
- [Create] action
-
Endpoint URL address:
/organization_subscriptions.json
.
The result is extracted from:{{=response.organization_subscription}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ organization_subscription: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/organization_subscriptions#create-organization-subscription.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/organization_subscriptions/{{=item.id}}.json
.Documentation: https://developer.zendesk.com/rest_api/docs/core/organization_subscriptions#delete-organization-subscription.
- id
A key field. Data type: DT_I4
- organization_id
Data type: DT_I4
- user_id
Data type: DT_I4
- created_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/organization_memberships.json
.
The result is extracted from:{{=response.organization_memberships}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/organization_memberships#list-memberships.
- [Read user_id] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/organization_memberships.json
.
The result is extracted from:{{=response.organization_memberships}}
.The action has the following user-defined parameters:
- user_id: Required. Specify user identifier.
- [Read organization_id] action
-
Endpoint URL address:
/organizations/{{=parameters.organization_id}}/organization_memberships.json
.
The result is extracted from:{{=response.organization_memberships}}
.The action has the following user-defined parameters:
- organization_id: Required. Specify organization identifier.
- [Create] action
-
Endpoint URL address:
/organization_memberships/create_many.json
.
The result is extracted from:{{=undefined}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ organization_memberships: batch } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/organization_memberships#create-many-memberships.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/organization_memberships/destroy_many.json
.
The result is extracted from:{{=undefined}}
.The following request parameters will be automatically processed:
-
ids:
{{=_.pluck(batch, 'id').join()}}
Documentation: https://developer.zendesk.com/rest_api/docs/core/organization_memberships#bulk-delete-memberships.
-
ids:
- id
A key field. Data type: DT_I4
- url
Template: ShortText. A read-only field.
- user_id
Data type: DT_I4 A read-only field.
- organization_id
Data type: DT_I4 A read-only field.
- default
Data type: DT_BOOL
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/automations.json
.
The result is extracted from:{{=response.automations}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/automations#list-automations.
- [Read active] action
-
Endpoint URL address:
/automations/active.json
.
The result is extracted from:{{=response.automations}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/automations#list-active-automations.
- [Read search] action
-
Endpoint URL address:
/automations/search.json
.
The result is extracted from:{{=response.automations}}
.The action has the following user-defined parameters:
- search: Required. Specify search query (alias for "query").
The following request parameters will be automatically processed:
-
query:
{{=parameters.search}}
Documentation: https://developer.zendesk.com/rest_api/docs/core/automations#search-automations.
- [Create] action
-
Endpoint URL address:
/automations.json
.
The result is extracted from:{{=response.automation}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ automation: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/automations#create-automation.
-
application/json:
- [Update] action
-
Endpoint URL address:
/automations/update_many.json
.
The result is extracted from:{{=response.automations}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ automations: batch } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/automations#update-many-automations.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/automations/destroy_many.json
.
The result is extracted from:{{=undefined}}
.The following request parameters will be automatically processed:
-
ids:
{{=_.pluck(batch, 'id').join()}}
Documentation: https://developer.zendesk.com/rest_api/docs/core/automations#bulk-delete-automations.
-
ids:
- id
A key field. Data type: DT_I4
- title
Template: ShortText.
- active
Data type: DT_BOOL
- position
Data type: DT_I4
- conditions
-
Field components:
- Contains the following components: all, any.
Documentation: https://developer.zendesk.com/rest_api/docs/core/automations#conditions.
- actions
-
Field components:
- An array.
-
Uses template:
Action
.
Documentation: https://developer.zendesk.com/rest_api/docs/core/automations#actions.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/macros.json
.
The result is extracted from:{{=response.macros}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/macros#list-macros.
- [Read active] action
-
Endpoint URL address:
/macros/active.json
.
The result is extracted from:{{=response.macros}}
.
- [Read search] action
-
Endpoint URL address:
/macros/search.json
.
The result is extracted from:{{=response.macros}}
.The action has the following user-defined parameters:
- search: Required. Specify search query (alias for "query").
The following request parameters will be automatically processed:
-
query:
{{=parameters.search}}
Documentation: https://developer.zendesk.com/rest_api/docs/core/macros#search-macros.
- [Create] action
-
Endpoint URL address:
/macros.json
.
The result is extracted from:{{=response.macro}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ macro: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/macros#create-macro.
-
application/json:
- [Update] action
-
Endpoint URL address:
/macros/update_many.json
.
The result is extracted from:{{=response.macros}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ macros: batch } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/macros#update-many-macros.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/macros/destroy_many.json
.
The result is extracted from:{{=undefined}}
.The following request parameters will be automatically processed:
-
ids:
{{=_.pluck(batch, 'id').join()}}
Documentation: https://developer.zendesk.com/rest_api/docs/core/macros#bulk-delete-macros.
-
ids:
- id
A key field. Data type: DT_I4
- title
Template: ShortText.
- actions
-
Field components:
- An array.
-
Uses template:
Action
.
Documentation: https://developer.zendesk.com/rest_api/docs/core/macros#actions.
- active
Data type: DT_BOOL
- description
Template: LongText.
- position
Data type: DT_I4
- restriction
Field components:
-
Uses template:
ShortText
. - Contains the following components: type, id, ids.
-
Uses template:
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- attachments
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/macros/actions.json
.
The result is extracted from:{{=response.actions}}
.
- target
Template: ShortText.
- title
Template: ShortText.
- values
Field components:
-
Uses template:
ShortText
. - Contains the following components: type, list.
-
Uses template:
- value
Template: ShortText.
- operators
Field components:
- An array.
- Contains the following components: value, title.
- group
Template: ShortText.
- title_for_field
Template: ShortText.
- output_key
Template: ShortText.
- field
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/macros/{{=parameters.macro_id}}/attachments.json
.
The result is extracted from:{{=response.macro_attachments}}
.The action has the following user-defined parameters:
- macro_id: Required. Specify macro identifier.
- id
A key field. Data type: DT_I4
- filename
Template: ShortText.
- content_type
Template: ShortText.
- content_url
Template: ShortText.
- size
Data type: DT_I4
- created_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/slas/policies
.
The result is extracted from:{{=response.sla_policies}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/sla_policies#list-sla-policies.
- [Create] action
-
Endpoint URL address:
/slas/policies
.
The result is extracted from:{{=response.sla_policy}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ sla_policy: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/sla_policies#create-sla-policy.
-
application/json:
- [Update] action
-
Endpoint URL address:
/slas/policies/{{=item.id}}
.
The result is extracted from:{{=response.sla_policy}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ sla_policy: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/sla_policies#update-sla-policy.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/slas/policies/{{=item.id}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/sla_policies#delete-sla-policy.
- id
A key field. Data type: DT_I4
- title
Template: ShortText.
- description
Template: LongText.
- position
Data type: DT_I4
- filter
-
Field components:
- Contains the following components: all, any.
Documentation: https://developer.zendesk.com/rest_api/docs/core/sla_policies#filter.
- policy_metrics
-
Field components:
- An array.
- Contains the following components: priority, metric, target, business_hours.
Documentation: https://developer.zendesk.com/rest_api/docs/core/sla_policies#policy-metric.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/targets.json
.
The result is extracted from:{{=response.targets}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/targets#list-targets.
- [Create] action
-
Endpoint URL address:
/targets.json
.
The result is extracted from:{{=response.target}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ target: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/targets#create-target.
-
application/json:
- [Update] action
-
Endpoint URL address:
/targets/{{=item.id}}.json
.
The result is extracted from:{{=response.target}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ target: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/targets#update-target.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/targets/{{=item.id}}.json
.Documentation: https://developer.zendesk.com/rest_api/docs/core/targets#delete-target.
- id
A key field. Data type: DT_I4
- title
Template: ShortText.
- type
Template: ShortText.
- active
Data type: DT_BOOL
- created_at
Data type: DT_BOOL A read-only field.
- target_url
Template: ShortText.
- username
Template: ShortText.
- password
Template: ShortText.
- token
Template: ShortText.
- project_id
Template: ShortText.
- resource
Template: ShortText.
- message_id
Template: ShortText.
- todo_list_id
Template: ShortText.
- subdomain
Template: ShortText.
- ssl
Data type: DT_BOOL
- room
Template: ShortText.
- preserve_format
Data type: DT_BOOL
- method
Template: ShortText.
- attribute
Template: ShortText.
- api_id
Template: ShortText.
- to
Template: ShortText.
- from
Template: ShortText.
- us_small_business_account
Data type: DT_BOOL
Template: ShortText.
- subject
Template: ShortText.
- api_token
Template: ShortText.
- account_name
Template: ShortText.
- story_type
Template: ShortText.
- story_title
Template: ShortText.
- requested_by
Template: ShortText.
- owner_by
Template: ShortText.
- story_labels
Template: ShortText.
- secret
Template: ShortText.
- content_type
Template: ShortText.
- group_id
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/triggers.json
.
The result is extracted from:{{=response.triggers}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/triggers#list-triggers.
- [Read active] action
-
Endpoint URL address:
/triggers/active.json
.
The result is extracted from:{{=response.triggers}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/triggers#list-active-triggers.
- [Read search] action
-
Endpoint URL address:
/triggers/search.json
.
The result is extracted from:{{=response.triggers}}
.The action has the following user-defined parameters:
- search: Required. Specify search query (alias for "query").
The following request parameters will be automatically processed:
-
query:
{{=parameters.search}}
Documentation: https://developer.zendesk.com/rest_api/docs/core/triggers#search-triggers.
- [Create] action
-
Endpoint URL address:
/triggers.json
.
The result is extracted from:{{=response.trigger}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ trigger: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/triggers#create-trigger.
-
application/json:
- [Update] action
-
Endpoint URL address:
/triggers/update_many.json
.
The result is extracted from:{{=response.triggers}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ triggers: batch } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/triggers#update-many-triggers.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/triggers/destroy_many.json
.The following request parameters will be automatically processed:
-
application/json:
{{={ ids: _.pluck(batch, 'id').join() } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/triggers#bulk-delete-triggers.
-
application/json:
- id
A key field. Data type: DT_I4
- title
Template: ShortText.
- active
Data type: DT_BOOL
- position
Data type: DT_I4
- conditions
-
Field components:
- An array.
- Contains the following components: all, any.
Documentation: https://developer.zendesk.com/rest_api/docs/core/triggers#conditions.
- actions
-
Field components:
- An array.
-
Uses template:
Action
.
Documentation: https://developer.zendesk.com/rest_api/docs/core/triggers#actions.
- description
Template: LongText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/views.json
.
The result is extracted from:{{=response.views}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/views#list-views.
- [Read active] action
-
Endpoint URL address:
/views/active.json
.
The result is extracted from:{{=response.views}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/views#list-active-views.
- [Read compact] action
-
Endpoint URL address:
/views/compact.json
.
The result is extracted from:{{=response.views}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/views#list-views---compact.
- [Read search] action
-
Endpoint URL address:
/views/search.json
.
The result is extracted from:{{=response.views}}
.The action has the following user-defined parameters:
- search: Required. Specify search query (alias for "query").
The following request parameters will be automatically processed:
-
query:
{{=parameters.search}}
Documentation: https://developer.zendesk.com/rest_api/docs/core/views#search-views.
- [Create] action
-
Endpoint URL address:
/views.json
.
The result is extracted from:{{=response.view}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ view: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/views#create-view.
-
application/json:
- [Update] action
-
Endpoint URL address:
/views/update_many.json
.
The result is extracted from:{{=response.views}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ views: batch } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/views#update-many-views.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/views/destroy_many.json
.The following request parameters will be automatically processed:
-
ids:
{{=_.pluck(batch, 'id').join()}}
Documentation: https://developer.zendesk.com/rest_api/docs/core/views#bulk-delete-views.
-
ids:
- id
A key field. Data type: DT_I4
- title
Template: ShortText.
- active
Data type: DT_BOOL
- sla_id
Data type: DT_I4
- restriction
Field components:
-
Uses template:
ShortText
. - Contains the following components: type, id.
-
Uses template:
- position
Data type: DT_I4
- execution
-
Field components:
-
Uses template:
ShortText
. - Contains the following components: group_by, sort_by, group_order, sort_order, columns, group, sort.
Documentation: https://developer.zendesk.com/rest_api/docs/core/views#execution.
-
Uses template:
- conditions
-
Field components:
- Contains the following components: all, any.
Documentation: https://developer.zendesk.com/rest_api/docs/core/views#conditions.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- ticket_count
-
Template: Count. The value is gathered from
/views/{{=item.id}}/count.json
address. The gathered value is processed with{{=response.view_count}}
expression.Documentation: https://developer.zendesk.com/rest_api/docs/core/views#view-count.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/audit_logs.json
.
The result is extracted from:{{=response.audit_logs}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/audit_logs#listing-audit-logs.
- id
A key field. Data type: DT_I4
- action
Template: ShortText.
- actor_id
Data type: DT_I4
- source_id
Data type: DT_I4
- source_type
Template: ShortText.
- source_label
Template: ShortText.
- changes_description
Template: LongText.
- ip_address
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/brands.json
.
The result is extracted from:{{=response.brands
.Documentation: https://developer.zendesk.com/rest_api/docs/core/brands#list-brands.
- [Create] action
-
Endpoint URL address:
/brands.json
.
The result is extracted from:{{=response.brand}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ brand: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/brands#create-brand.
-
application/json:
- [Update] action
-
Endpoint URL address:
/brands/{{=item.id}}.json
.
The result is extracted from:{{=response.brand}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ brand: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/brands#update-a-brand.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/brands/{{=item.id}}.json
.Documentation: https://developer.zendesk.com/rest_api/docs/core/brands#delete-a-brand.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- url
Template: ShortText. A read-only field.
- brand_url
Template: ShortText.
- has_help_center
Data type: DT_BOOL
- help_center_state
Template: ShortText. A read-only field.
- active
Data type: DT_BOOL
- default
Data type: DT_BOOL
- logo
Template: Attachment.
- ticket_form_ids
Template: LongText. A read-only field. A composite field.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- subdomain
Template: ShortText.
- host_mapping
Template: ShortText.
- signature_template
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/dynamic_content/items.json
.
The result is extracted from:{{=response.items}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/dynamic_content#list-items.
- [Create] action
-
Endpoint URL address:
/dynamic_content/items.json
.
The result is extracted from:{{=response.item}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ 'item': item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/dynamic_content#create-item.
-
application/json:
- [Update] action
-
Endpoint URL address:
/dynamic_content/items/{{=item.id}}.json
.
The result is extracted from:{{=response.item}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ 'item': item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/dynamic_content#update-item.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/dynamic_content/items/{{=item.id}}.json
.Documentation: https://developer.zendesk.com/rest_api/docs/core/dynamic_content#delete-item.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- url
Template: ShortText. A read-only field.
- placeholder
Template: ShortText. A read-only field.
- default_locale_id
Data type: DT_I4
- outdated
Data type: DT_BOOL A read-only field.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- variants
-
Field components:
- An array.
-
Uses template:
VariantT
.
Documentation: https://developer.zendesk.com/rest_api/docs/core/dynamic_content#variants.
- content
Template: LongText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/dynamic_content/items/{{=parameters.item_id}}/variants.json
.
The result is extracted from:{{=response.variants}}
.The action has the following user-defined parameters:
- item_id: Required. Specify dynamic content item identifier.
Documentation: https://developer.zendesk.com/rest_api/docs/core/dynamic_content#list-variants.
- [Create] action
-
Endpoint URL address:
/dynamic_content/items/{{=item.item_id}}/variants.json
.
The result is extracted from:{{=response.variant}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ variant: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/dynamic_content#create-variant.
-
application/json:
- [Update] action
-
Endpoint URL address:
/dynamic_content/items/{{=item.item_id}}/variants/{{=item.id}}.json
.
The result is extracted from:{{=response.variant}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ variant: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/dynamic_content#update-variant.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/dynamic_content/items/{{=item.item_id}}/variants/{{=item.id}}.json
.Documentation: https://developer.zendesk.com/rest_api/docs/core/dynamic_content#delete-variant.
The resource includes the fields from the VariantT template.
- item_id
A key field. Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/locales/agent.json
.
The result is extracted from:{{=response.locales}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/locales#list-locales.
- [Read public] action
-
Endpoint URL address:
/locales/public.json
.
The result is extracted from:{{=response.locales}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/locales#list-available-public-locales.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- url
Template: ShortText.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/organization_fields.json
.
The result is extracted from:{{=response.organization_fields}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/organization_fields#list-organization-fields.
- [Create] action
-
Endpoint URL address:
/organization_fields.json
.
The result is extracted from:{{=response.organization_field}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ organization_field: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/organization_fields#create-organization-fields.
-
application/json:
- [Update] action
-
Endpoint URL address:
/organization_fields/{{=item.id}}.json
.
The result is extracted from:{{=response.organization_field}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ organization_field: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/organization_fields#update-organization-fields.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/organization_fields/{{=item.id}}.json
.Documentation: https://developer.zendesk.com/rest_api/docs/core/organization_fields#delete-organization-field.
- id
A key field. Data type: DT_I4
- key
Template: ShortText.
- url
Template: ShortText. A read-only field.
- type
Template: ShortText.
- title
Template: ShortText.
- raw_title
Template: ShortText.
- description
Template: LongText.
- raw_description
Template: LongText.
- position
Data type: DT_I4
- active
Data type: DT_BOOL
- system
Data type: DT_BOOL A read-only field.
- regexp_for_validation
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- tag
Template: ShortText.
- custom_field_options
A read-only field. Field components:
- An array.
-
Uses template:
FieldOption
.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/business_hours/schedules.json
.
The result is extracted from:{{=response.schedules}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/schedules#list-all-schedules.
- [Create] action
-
Endpoint URL address:
/business_hours/schedules.json
.
The result is extracted from:{{=response.schedule}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ schedule: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/schedules#create-a-schedule.
-
application/json:
- [Update] action
-
Endpoint URL address:
/business_hours/schedules/{{=item.id}}.json
.
The result is extracted from:{{=response.schedule}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ schedule: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/schedules#update-a-schedule.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/business_hours/schedules/{{=item.id}}.json
.Documentation: https://developer.zendesk.com/rest_api/docs/core/schedules#delete-a-schedule.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- time_zone
Template: ShortText.
- intervals
-
Field components:
- An array.
- Contains the following components: start_time, end_time.
Documentation: https://developer.zendesk.com/rest_api/docs/core/schedules#intervals.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- start_date
Template: Date.
- end_date
Template: Date.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/business_hours/schedules/{{=parameters.schedule_id}}/holidays.json
.
The result is extracted from:{{=response.holidays}}
.The action has the following user-defined parameters:
- schedule_id: Required. Specify schedule identifier.
Documentation: https://developer.zendesk.com/rest_api/docs/core/schedules#list-holidays-for-a-schedule.
- [Create] action
-
Endpoint URL address:
/business_hours/schedules/{{=item.schedule_id}}/holidays.json
.
The result is extracted from:{{=response.holiday}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ holiday: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/schedules#create-a-holiday.
-
application/json:
- [Update] action
-
Endpoint URL address:
/business_hours/schedules/{{=item.schedule_id}}/holidays/{{=item.id}}.json
.
The result is extracted from:{{=response.holiday}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ holiday: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/schedules#update-a-holiday.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/business_hours/schedules/{{=item.schedule_id}}/holidays/{{=item.id}}.json
.Documentation: https://developer.zendesk.com/rest_api/docs/core/schedules#delete-a-holiday.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- start_date
Template: Date.
- end_date
Template: Date.
- schedule_id
A key field. Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/sharing_agreements.json
.
The result is extracted from:{{=response.sharing_agreements}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/sharing_agreements#list-sharing-agreements.
- [Create] action
-
Endpoint URL address:
/sharing_agreements.json
.
The result is extracted from:{{=response.sharing_agreement}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ sharing_agreement: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/sharing_agreements#create-sharing-agreement.
-
application/json:
- [Update] action
-
Endpoint URL address:
/sharing_agreements/{{=item.id}}.json
.
The result is extracted from:{{=response.sharing_agreement}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ sharing_agreement: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/sharing_agreements#update-a-sharing-agreement.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/sharing_agreements/{{=item.id}}.json
.Documentation: https://developer.zendesk.com/rest_api/docs/core/sharing_agreements#delete-a-sharing-agreement.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- type
Template: ShortText.
- status
Template: ShortText.
- partner_name
Template: ShortText.
- remote_subdomain
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/recipient_addresses.json
.
The result is extracted from:{{=response.recipient_addresses}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/support_addresses#list-support-addresses.
- [Create] action
-
Endpoint URL address:
/recipient_addresses.json
.
The result is extracted from:{{=response.recipient_address}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ recipient_address: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/support_addresses#create-support-address.
-
application/json:
- [Update] action
-
Endpoint URL address:
/recipient_addresses/{{=item.id}}.json
.
The result is extracted from:{{=response.recipient_address}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ recipient_address: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/support_addresses#update-support-address.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/recipient_addresses/{{=item.id}}.json
.Documentation: https://developer.zendesk.com/rest_api/docs/core/support_addresses#delete-recipient-address.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
Template: ShortText.
- default
Data type: DT_BOOL
- brand_id
Template: ShortText.
- forwarding_status
Template: ShortText. A read-only field.
- spf_status
Template: ShortText. A read-only field.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/ticket_forms.json
.
The result is extracted from:{{=response.ticket_forms}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/ticket_forms#list-ticket-forms.
- [Create] action
-
Endpoint URL address:
/ticket_forms.json
.
The result is extracted from:{{=response.ticket_form}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ ticket_form: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/ticket_forms#create-ticket-forms.
-
application/json:
- [Update] action
-
Endpoint URL address:
/ticket_forms/{{=item.id}}.json
.
The result is extracted from:{{=response.ticket_form}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ ticket_form: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/ticket_forms#update-ticket-forms.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/ticket_forms/{{=item.id}}.json
.Documentation: https://developer.zendesk.com/rest_api/docs/core/ticket_forms#delete-ticket-form.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- url
Template: ShortText. A read-only field.
- raw_name
Template: ShortText.
- display_name
Template: ShortText.
- raw_display_name
Template: ShortText.
- position
Data type: DT_I4
- active
Data type: DT_BOOL
- end_user_visible
Data type: DT_BOOL
- default
Data type: DT_BOOL
- ticket_field_ids
Template: LongText. A composite field.
- in_all_brands
Data type: DT_BOOL
- restricted_brand_ids
Template: LongText. A read-only field. A composite field.
- in_all_organizations
Data type: DT_BOOL
- restricted_organization_ids
Template: LongText. A composite field.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/ticket_fields.json
.
The result is extracted from:{{=response.ticket_fields}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/ticket_fields#list-ticket-fields.
- [Create] action
-
Endpoint URL address:
/ticket_fields.json
.
The result is extracted from:{{=response.ticket_field}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ ticket_field: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/ticket_fields#create-ticket-field.
-
application/json:
- [Update] action
-
Endpoint URL address:
/ticket_fields/{{=item.id}}.json
.
The result is extracted from:{{=response.ticket_field}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ ticket_field: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/ticket_fields#update-ticket-field.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/ticket_fields/{{=item.id}}.json
.Documentation: https://developer.zendesk.com/rest_api/docs/core/ticket_fields#delete-ticket-field.
- id
A key field. Data type: DT_I4
- title
Template: ShortText.
- url
Template: ShortText. A read-only field.
- type
Template: ShortText.
- raw_title
Template: ShortText.
- description
Template: LongText.
- raw_description
Template: LongText.
- position
Data type: DT_I4
- active
Data type: DT_BOOL
- required
Data type: DT_BOOL
- collapsed_for_agents
Data type: DT_BOOL
- regexp_for_validation
Template: ShortText.
- title_in_portal
Template: ShortText.
- raw_title_in_portal
Template: ShortText.
- visible_in_portal
Data type: DT_BOOL
- editable_in_portal
Data type: DT_BOOL
- required_in_portal
Data type: DT_BOOL
- tag
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- system_field_options
Template: LongText. A composite field.
- custom_field_options
A read-only field. The value is gathered from
/ticket_fields/{{=item.id}}/options.json
address. Field components:- An array.
-
Uses template:
FieldOption
.
- removable
Data type: DT_BOOL A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/ticket_fields/{{=parameters.field_id}}/options.json
.
The result is extracted from:{{=response.custom_field_options}}
.The action has the following user-defined parameters:
- field_id: Required. Specify ticket field idenitifier.
Documentation: https://developer.zendesk.com/rest_api/docs/core/ticket_fields#list-ticket-field-options.
- [Create] action
-
Endpoint URL address:
/ticket_fields/{{=item.field_id}}/options
.
The result is extracted from:{{=response.custom_field_option}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ custom_field_option: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/ticket_fields#create-or-update-a-ticket-field-option.
-
application/json:
- [Update] action
-
Endpoint URL address:
/ticket_fields/{{=item.field_id}}/options/{{=item.id}}.json
.
The result is extracted from:{{=response.custom_field_option}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ custom_field_option: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/ticket_fields#create-or-update-a-ticket-field-option.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/ticket_fields/{{=item.field_id}}/options/{{=item.id}}.json
.Documentation: https://developer.zendesk.com/rest_api/docs/core/ticket_fields#delete-ticket-field-option.
The resource includes the fields from the FieldOption template.
- field_id
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/user_fields.json
.
The result is extracted from:{{=response.user_fields}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/user_fields#list-user-fields.
- [Create] action
-
Endpoint URL address:
/user_fields.json
.
The result is extracted from:{{=response.user_field}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ user_field: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/user_fields#create-user-fields.
-
application/json:
- [Update] action
-
Endpoint URL address:
/user_fields/{{=item.id}}.json
.
The result is extracted from:{{=response.user_field}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ user_field: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/user_fields#update-user-fields.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/user_fields/{{=item.id}}.json
.Documentation: https://developer.zendesk.com/rest_api/docs/core/user_fields#delete-user-field.
- id
A key field. Data type: DT_I4
- key
Template: ShortText.
- url
Template: ShortText. A read-only field.
- type
Template: ShortText.
- title
Template: ShortText.
- raw_title
Template: ShortText.
- description
Template: LongText.
- raw_description
Template: LongText.
- position
Data type: DT_I4
- active
Data type: DT_BOOL
- system
Data type: DT_BOOL A read-only field.
- regexp_for_validation
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- tag
Template: ShortText.
- custom_field_options
A read-only field. The value is gathered from
/user_fields/{{=item.id}}/options.json
address. Field components:- An array.
-
Uses template:
FieldOption
.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/user_fields/{{=parameters.field_id}}/options.json
.
The result is extracted from:{{=response.custom_field_options}}
.The action has the following user-defined parameters:
- field_id: Required. Specify user field identifier.
Documentation: https://developer.zendesk.com/rest_api/docs/core/user_fields#list-user-field-options.
- [Create] action
-
Endpoint URL address:
/user_fields/{{=item.field_id}}/options.json
.
The result is extracted from:{{=response.custom_field_option}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ custom_field_option: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/user_fields#create-or-update-a-user-field-option.
-
application/json:
- [Update] action
-
Endpoint URL address:
/user_fields/{{=item.field_id}}/options/{{=item.id}}.json
.
The result is extracted from:{{=response.custom_field_option}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ custom_field_option: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/user_fields#create-or-update-a-user-field-option.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/user_fields/{{=item.field_id}}/options/{{=item.id}}.json
.Documentation: https://developer.zendesk.com/rest_api/docs/core/user_fields#delete-user-field-option.
The resource includes the fields from the FieldOption template.
- field_id
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/apps.json
.
The result is extracted from:{{=response.apps}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/apps#list-all-apps.
- [Read owned] action
-
Endpoint URL address:
/apps/owned.json
.
The result is extracted from:{{=response.apps}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/apps#list-owned-apps.
- [Delete] action
-
Endpoint URL address:
/apps/{{=item.id}}.json
.Documentation: https://developer.zendesk.com/rest_api/docs/core/apps#delete-app.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- large_icon
Template: ShortText.
- author_name
Template: ShortText.
- visibility
Template: ShortText.
- promoted
Data type: DT_BOOL
- author_email
Template: ShortText.
- installable
Data type: DT_BOOL
- installation_instructions
Template: LongText.
- long_description
Template: LongText.
- featured
Data type: DT_BOOL
- raw_long_description
Template: LongText.
- single_install
Data type: DT_BOOL
- small_icon
Template: ShortText.
- version
Template: ShortText.
- rating
Field components:
- Contains the following components: total_count, average, count.
- categories
Template: LongText. A composite field.
- raw_installation_instructions
Template: LongText.
- parameters
Field components:
- An array.
- Contains the following components: id, name, secure, position, app_id, created_at, updated_at, kind, required, default_value.
- default_locale
Template: ShortText.
- short_description
Template: ShortText.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- owner_id
Data type: DT_I4
- screenshots
Template: LongText. A composite field.
- framework_version
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/apps/installations.json
.
The result is extracted from:{{=response.installations}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/apps#list-app-installations.
- [Create] action
-
Endpoint URL address:
/apps/installations.json
.
The result is extracted from:{{=response.installation}}
.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
Documentation: https://developer.zendesk.com/rest_api/docs/core/apps#install-app.
-
application/json:
- [Update] action
-
Endpoint URL address:
/apps/installations/{{=item.id}}.json
.
The result is extracted from:{{=response.installation}}
.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
Documentation: https://developer.zendesk.com/rest_api/docs/core/apps#update-app-installation.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/apps/installations/{{=item.id}}.json
.Documentation: https://developer.zendesk.com/rest_api/docs/core/apps#remove-app-installation.
- id
A key field. Data type: DT_I4
- app_id
Data type: DT_I4
- enabled
Data type: DT_BOOL
- settings
Field components:
-
Uses template:
ShortText
. - Contains the following components: title, api_token, use_ssl.
-
Uses template:
- requirements
A read-only field. The value is gathered from
/apps/installations/{{=item.id}}/requirements.json
address. Field components:- An array.
- Contains the following components: account_id, identifier, requirement_id, requirement_type, created_at, updated_at.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/apps/location_installations.json
.
The result is extracted from:{{=response.location_installations}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/app_location_installations#list-location-installations.
- id
A key field. Data type: DT_I4
- location_name
Template: ShortText.
- installations
Template: LongText. A composite field.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/apps/locations.json
.
The result is extracted from:{{=response.locations}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/app_locations#list-locations.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- product_code
Data type: DT_I4
- host_application
Template: ShortText.
- orderable
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/oauth/clients.json
.
The result is extracted from:{{=response.clients}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/oauth_clients#list-clients.
- [Read me] action
-
Endpoint URL address:
/users/me/oauth/clients.json
.
The result is extracted from:{{=response.clients}}
.
- [Create] action
-
Endpoint URL address:
/oauth/clients.json
.
The result is extracted from:{{=response.client}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ client: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/oauth_clients#create-client.
-
application/json:
- [Update] action
-
Endpoint URL address:
/oauth/clients/{{=item.id}}.json
.
The result is extracted from:{{=response.client}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ client: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/oauth_clients#update-client.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/oauth/clients/{{=item.id}}.json
.Documentation: https://developer.zendesk.com/rest_api/docs/core/oauth_clients#delete-client.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- url
Template: ShortText. A read-only field.
- identifier
Template: ShortText.
- secret
Template: ShortText. A read-only field.
- company
Template: ShortText.
- description
Template: LongText.
- redirect_uri
Template: LongText. A composite field.
- user_id
Data type: DT_I4
- global
Data type: DT_BOOL
- logo_url
Template: ShortText. A read-only field.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/oauth/tokens.json
.
The result is extracted from:{{=response.tokens}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/oauth_tokens#list-tokens.
- [Create] action
-
Endpoint URL address:
/oauth/tokens.json
.
The result is extracted from:{{=response.token}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ token: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/oauth_tokens#create-token.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/oauth/tokens/{{=item.id}}.json
.Documentation: https://developer.zendesk.com/rest_api/docs/core/oauth_tokens#revoke-token.
- id
A key field. Data type: DT_I4
- user_id
Data type: DT_I4
- client_id
Data type: DT_I4
- token
Template: ShortText.
- refresh_token
Template: ShortText.
- scopes
Template: LongText. A composite field.
- url
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- expires_at
Template: DateTime. A read-only field.
- used_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/oauth/global_clients.json
.
The result is extracted from:{{=response.global_clients}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/global_clients#list-authorized-global-clients.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- identifier
Template: ShortText.
- company
Template: ShortText.
- description
Template: ShortText.
- logo_url
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/activities.json
.
The result is extracted from:{{=response.activities}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/activity_stream#list-activities.
- id
A key field. Data type: DT_I4
- title
Template: ShortText.
- url
Template: ShortText.
- verb
Template: ShortText.
- user
Template: UserT.
- actor
Template: UserT.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- object
Template: LongText. A composite field.
- target
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/bookmarks.json
.
The result is extracted from:{{=response.bookmarks}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/bookmarks#list-bookmarks.
- [Create] action
-
Endpoint URL address:
/bookmarks.json
.
The result is extracted from:{{=response.bookmark}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ bookmark: item } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/bookmarks#create-bookmark.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/bookmarks/{{=item.id}}.json
.Documentation: https://developer.zendesk.com/rest_api/docs/core/bookmarks#delete-bookmark.
- id
A key field. Data type: DT_I4
- ticket_id
Data type: DT_I4
- url
Template: ShortText. A read-only field.
- ticket
Template: TicketT. A read-only field.
- created_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/resource_collections.json
.
The result is extracted from:{{=response.resource_collections}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/resource_collections#list-resource-collections.
- [Create] action
-
Endpoint URL address:
/resource_collections.json
.The following request parameters will be automatically processed:
-
application/json:
{{={ payload: item.payload } }}
Documentation: https://developer.zendesk.com/rest_api/docs/core/resource_collections#create-a-resource-collection.
-
application/json:
- [Update] action
-
Endpoint URL address:
/resource_collections/{{=item.id}}.json
.Documentation: https://developer.zendesk.com/rest_api/docs/core/resource_collections#update-a-resource-collection.
- [Delete] action
-
Endpoint URL address:
/resource_collections/{{=item.id{}.json
.Documentation: https://developer.zendesk.com/rest_api/docs/core/resource_collections#delete-a-resource-collection.
- id
A key field. Data type: DT_I4
- payload
Template: LongText. A composite field.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/tags.json
.
The result is extracted from:{{=response.tags}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/tags#list-tags.
- name
Template: ShortText.
- count
Data type: DT_I4
Based on resource template TagT.
Based on resource template TagT.
Based on resource template TagT.
Based on resource template TagT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/channels/twitter/monitored_twitter_handles.json
.
The result is extracted from:{{=response.monitored_twitter_handles}}
.Documentation: https://developer.zendesk.com/rest_api/docs/core/twitter_channel#listing-monitored-twitter-handles.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- screen_name
Template: ShortText.
- twitter_user_id
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- avatar_url
Template: ShortText.
- allow_reply
Data type: DT_BOOL
- can_reply
Data type: DT_BOOL
- brand_id
Template: ShortText.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
page:
{{=parameters.iterator}}
-
_includeUserParameters:
{{=parameters}}
-
page:
- [Create] action
-
The action uses POST method.
- [Update] action
-
The action uses PUT method.
- [Delete] action
-
The action uses DELETE method.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
{{='/' + resource.object + '/' + parameters.object_id + '/tags.json'}}
.
The result is extracted from:{{=_.map(response.tags, function(tag) { return { name: tag }; })}}
.The action has the following user-defined parameters:
- object_id: Required. Specify object identifier.
- [Create] action
-
Endpoint URL address:
{{='/' + resource.object + '/' + item.object_id + '/tags.json'}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ tags: _.pluck(batch, 'name') } }}
-
application/json:
- [Update] action
-
Endpoint URL address:
{{='/' + resource.object + '/' + item.object_id + '/tags.json'}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ tags: _.pluck(batch, 'name') } }}
-
application/json:
- [Delete] action
-
Endpoint URL address:
{{='/' + resource.object + '/' + item.object_id + '/tags.json'}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ tags: _.pluck(batch, 'name') } }}
-
application/json:
- name
Template: ShortText.
- count
Data type: DT_I4 A read-only field.
- object_id
A key field. Data type: DT_I4
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Via
Field components:
-
Uses template:
ShortText
. - Contains the following components: channel, source.
-
Uses template:
- Attachment
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, file_name, content_url, content_type, size, thumbnails.
-
Uses template:
- Comment
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, type, body, html_body, plain_body, public, author_id, attachments, via, metadata, created_at.
-
Uses template:
- Requester
Field components:
-
Uses template:
ShortText
. - Contains the following components: locale_id, name, email.
-
Uses template:
- TicketT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, url, external_id, type, subject, raw_subject, description, priority, status, recipient, requester_id, submitter_id, assignee_id, organization_id, group_id, collaborator_ids, forum_topic_id, problem_id, has_incidents, due_at, tags, via, satisfaction_rating, sharing_agreement_ids, followup_ids, ticket_form_id, brand_id, allow_channelback, is_public, created_at, updated_at, comment, collaborators, via_followup_source_id, requester.
-
Uses template:
- TimeInMinutes
Field components:
- Contains the following components: calendar, business.
- Condition
Field components:
-
Uses template:
ShortText
. - Contains the following components: field, operator, value.
-
Uses template:
- Action
Field components:
-
Uses template:
ShortText
. - Contains the following components: field, value.
-
Uses template:
- Count
Field components:
-
Uses template:
ShortText
. - Contains the following components: url, value, pretty, fresh.
-
Uses template:
- VariantT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, url, content, locale_id, outdated, active, default, created_at, updated_at.
-
Uses template:
- Date
Before setting, the value is processed with
{{=value && dateFormat(value, 'yyyy-mm-dd')}}
expression.- FieldOption
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, name, position, raw_name, url, value.
-
Uses template:
- UserT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, email, name, active, alias, chat_only, created_at, custom_role_id, details, external_id, last_login_at, locale, locale_id, moderator, notes, only_private_comments, organization_id, default_group_id, phone, photo, restricted_agent, role, shared, shared_agent, signature, suspended, tags, ticket_restriction, time_zone, two_factor_auth_enabled, updated_at, url, verified, remote_photo_url.
-
Uses template:
What's New
- New: Updated 'Organization Membership' resource to use cursor pagination.
- New: Included cursor pagination for Ticket and User resources.
- New: Improved handling of custom fields in 'User' resource.
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.