arazzo: 1.0.1
info:
title: Zendesk Assign Organization to Ticket
summary: Find an organization by name, then attach a ticket to it for shared visibility.
description: >-
A scoping pattern for Zendesk Support. The workflow searches organizations by
exact name, branches on whether a match was found, and when found updates the
ticket to attach it to that organization. The update body uses the documented
{ticket:{...}} envelope and is spelled out inline.
version: 1.0.0
x-realizes-capability-ids:
- BC-420.10
- BC-430.10
x-capability-derivation:
method: 'deterministic join: sourceDescriptions -> per-tag OpenAPI -> tag/capability edge. No classification at this step.'
min_confidence: 0.7
sources:
- capability_id: BC-420.10
capability_name: Customer Data Management
spec: zendesk-organizations-api-openapi.yml
confidence: 0.8
- capability_id: BC-430.10
capability_name: Customer Inquiry Management
spec: zendesk-tickets-api-openapi.yml
confidence: 0.92
model: Turbo EA Capabilities by Vincent Verdet — Turbo EA, https://github.com/vincentmakes/turbo-ea-capabilities, CC BY 4.0
sourceDescriptions:
- name: organizationsApi
url: ../openapi/zendesk-organizations-api-openapi.yml
type: openapi
- name: ticketsApi
url: ../openapi/zendesk-tickets-api-openapi.yml
type: openapi
workflows:
- workflowId: assign-organization-ticket
summary: Resolve an organization by name and attach a ticket to it.
description: >-
Searches organizations by name and, when found, updates the supplied ticket
to belong to that organization.
inputs:
type: object
required:
- organizationName
- ticketId
properties:
organizationName:
type: string
description: The exact name of the organization to attach.
ticketId:
type: integer
description: The id of the ticket to scope to the organization.
steps:
- stepId: findOrganization
description: Search for the organization by exact name.
operationId: SearchOrganizations
parameters:
- name: name
in: query
value: $inputs.organizationName
successCriteria:
- condition: $statusCode == 200
outputs:
organizationId: $response.body#/organizations/0/id
onSuccess:
- name: organizationFound
type: goto
stepId: attachOrganization
criteria:
- context: $response.body
condition: $.organizations.length > 0
type: jsonpath
- stepId: attachOrganization
description: Update the ticket to belong to the resolved organization.
operationId: UpdateTicket
parameters:
- name: ticket_id
in: path
value: $inputs.ticketId
requestBody:
contentType: application/json
payload:
ticket:
organization_id: $steps.findOrganization.outputs.organizationId
successCriteria:
- condition: $statusCode == 200
outputs:
ticketId: $response.body#/ticket/id
organizationId: $response.body#/ticket/organization_id
outputs:
organizationId: $steps.findOrganization.outputs.organizationId
ticketId: $steps.attachOrganization.outputs.ticketId
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.