Zendesk

Zendesk Targets API

The Zendesk Targets API lets you programmatically manage targets, which are external destinations that Zendesk Support triggers and automations can notify when conditions are met. Using the API, you can create, list, update, activate/deactivate, and delete targets, configure details such as URLs, HTTP methods, authentication, and content types, and review delivery failures to troubleshoot outbound notifications.

Documentation GitHub OpenAPI

Documentation

📖

Documentation

https://developer.zendesk.com/api-reference/ticketing/targets/targets/

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/zendesk/refs/heads/main/openapi/targets-openapi-original.yml

OpenAPI Specification

openapi: 3.1.0
info:
  version: "1.0"
  title: Zendesk Targets
  description: Needs a description.
paths:
  /api/v2/targets:
    get:
      operationId: ListTargets
      tags:
        - Targets
      summary: Zendesk Get  Api V2 Targets
      description: |
        #### Allowed For

        * Agents
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TargetsResponse'
              examples:
                default:
                  $ref: '#/components/examples/TargetsResponseExample'
    post:
      operationId: CreateTarget
      tags:
        - Targets
      summary: Zendesk Post  Api V2 Targets
      description: |
        #### Allowed For

        * Admins
      responses:
        '201':
          description: Created response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TargetResponse'
              examples:
                default:
                  $ref: '#/components/examples/TargetCreateResponseExample'
  /api/v2/targets/{target_id}:
    parameters:
      - $ref: '#/components/parameters/TargetId'
    get:
      operationId: ShowTarget
      tags:
        - Targets
      summary: Zendesk Get  Api V2 Targets Target_id
      description: |
        #### Allowed For

        * Agents
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TargetResponse'
              examples:
                default:
                  $ref: '#/components/examples/TargetResponseExample'
    put:
      operationId: UpdateTarget
      tags:
        - Targets
      summary: Zendesk Put  Api V2 Targets Target_id
      description: |
        #### Allowed For
        * Admins
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TargetResponse'
              examples:
                default:
                  $ref: '#/components/examples/TargetUpdateResponseExample'
    delete:
      operationId: DeleteTarget
      tags:
        - Targets
      summary: Zendesk Delete  Api V2 Targets Target_id
      description: |
        #### Allowed For
        * Admins
      responses:
        '204':
          description: No Content response
components:
  schemas:
    TargetsResponse:
      type: object
      properties:
        targets:
          type: array
          items:
            $ref: '#/components/schemas/TargetObject'
    TargetResponse:
      type: object
      properties:
        target:
          $ref: '#/components/schemas/TargetObject'
tags:
  - name: Targets