> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bijection.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Zendesk

> Resources, examples, configuration and evidence for Zendesk.

Use the `@bijection/connectors/zendesk` entrypoint to declare Zendesk resources.

## Availability

This page describes the pinned source package. Published availability is unestablished for this artifact. [Source build and package availability](https://docs.bijection.com/client/sdk-distribution.md).

## Resources and modes

| Resource | Mode | Description |
| - | - | - |
| tickets | `observations` | Evidence-checked tickets |

Declare a resource in application code, then bind deployment-specific settings and credentials. See [typed resources](https://docs.bijection.com/integrations/resources.md), [connections](https://docs.bijection.com/integrations/connections.md) and [source inspection](https://docs.bijection.com/integrations/cli.md).

## tickets

### observations: Evidence-checked tickets

The following example matches configuration `standard`.

```ts theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
import { zendesk } from "@bijection/connectors/zendesk";
export const tickets = zendesk.tickets.observations();
```

> **Inferred record types**
>
> ```ts theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
> {
>   "ticket_id": number;
>   "subject": string | null;
>   "status": string;
>   "created_at": string;
>   "updated_at": string;
>   "external_id": string | null;
>   "requester_id": number | null;
> }
> ```

#### Configuration: standard

Case: `zendesk/tickets/observations/standard`.

Connection and resource configuration are declared by this exact case.

Credential kind: `zendesk`. Keep credential material in the private credential inventory.

| Setting | Type | Required | Owner |
| - | - | - | - |
| `subdomain` | string | Yes | Shared connection |

Provider setup requirements:

```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
[
  {
    "key": "subdomain",
    "supplier": "account",
    "label": "Zendesk subdomain",
    "help": "The name in the address you sign in at.",
    "docUrl": "https://developer.zendesk.com/api-reference/introduction/security-and-auth/",
    "example": "acme",
    "prefix": "https://",
    "suffix": ".zendesk.com/api/v2/",
    "pattern": "[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?",
    "minLength": 1,
    "maxLength": 63,
    "fills": "base_url"
  }
]
```

> **Complete configuration contract**
>
> ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
> {
>   "setup": [
>     {
>       "key": "subdomain",
>       "supplier": "account",
>       "label": "Zendesk subdomain",
>       "help": "The name in the address you sign in at.",
>       "docUrl": "https://developer.zendesk.com/api-reference/introduction/security-and-auth/",
>       "example": "acme",
>       "prefix": "https://",
>       "suffix": ".zendesk.com/api/v2/",
>       "pattern": "[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?",
>       "minLength": 1,
>       "maxLength": 63,
>       "fills": "base_url"
>     }
>   ],
>   "resource": {
>     "access": {},
>     "defaults": {},
>     "connector": "zendesk",
>     "output": {
>       "kind": "single",
>       "collection": "tickets"
>     },
>     "credential_kind": "zendesk",
>     "connection_fields": [
>       "subdomain"
>     ],
>     "address": {
>       "kind": "setup",
>       "field": "subdomain",
>       "prefix": "https://",
>       "suffix": ".zendesk.com/api/v2/"
>     }
>   },
>   "connection_setup": {
>     "type": "object",
>     "value": {
>       "subdomain": {
>         "fieldType": {
>           "type": "string"
>         },
>         "optional": false
>       }
>     }
>   },
>   "execution": null
> }
> ```

Native admission analysis is available for this exact declaration.

**Collection: tickets**

| Contract | Meaning |
| - | - |
| Initial | Current membership |
| Changes | Repeated observations of current records |
| Deletions | Withdrawal from selected scope |
| Resume | Opaque cursor |
| Gap | Explicit repair required after a gap |
| Retention | Unspecified |

> **Complete native profile**
>
> ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
> {
>   "movement": {
>     "exchanges": {
>       "tickets": {
>         "200": {
>           "placement": "retained_bytes",
>           "interpretation": "json",
>           "projectsBeforeRetention": false,
>           "retainedBodyLimitBytes": "524288",
>           "fileLimitBytes": null
>         },
>         "400": {
>           "placement": "retained_bytes",
>           "interpretation": "opaque",
>           "projectsBeforeRetention": false,
>           "retainedBodyLimitBytes": "524288",
>           "fileLimitBytes": null
>         },
>         "429": {
>           "placement": "retained_bytes",
>           "interpretation": "opaque",
>           "projectsBeforeRetention": false,
>           "retainedBodyLimitBytes": "524288",
>           "fileLimitBytes": null
>         }
>       }
>     },
>     "nativeInputLimitBytes": null,
>     "steps": [
>       {
>         "id": "acquire.1",
>         "inputs": [],
>         "action": {
>           "operation": "acquire",
>           "subject": "exchange tickets",
>           "limitBytes": null
>         }
>       },
>       {
>         "id": "acquire.2",
>         "inputs": [],
>         "action": {
>           "operation": "acquire",
>           "subject": "listener changes",
>           "limitBytes": null
>         }
>       },
>       {
>         "id": "retain.1",
>         "inputs": [
>           "acquire.1",
>           "acquire.2"
>         ],
>         "action": {
>           "operation": "retain",
>           "subject": "acquisition evidence",
>           "reason": "recovery",
>           "release": "acquisition_custody"
>         }
>       },
>       {
>         "id": "interpret.1",
>         "inputs": [
>           "retain.1"
>         ],
>         "action": {
>           "operation": "interpret",
>           "subject": "acquired input",
>           "produces": "records"
>         }
>       },
>       {
>         "id": "materialize.1",
>         "inputs": [
>           "interpret.1"
>         ],
>         "action": {
>           "operation": "materialize",
>           "subject": "source rows",
>           "reason": "serving",
>           "release": "replacement"
>         }
>       },
>       {
>         "id": "publish.1",
>         "inputs": [
>           "materialize.1"
>         ],
>         "action": {
>           "operation": "publish",
>           "subject": "source rows",
>           "visibility": "with_acquisition"
>         }
>       }
>     ]
>   },
>   "initial": "current_membership",
>   "changes": "observations",
>   "deletions": "scope_membership",
>   "resume": "opaque_cursor",
>   "retentionMs": null,
>   "gap": "explicit_repair",
>   "limits": {
>     "http_response_bytes": "524288",
>     "initial_rows": "100"
>   },
>   "restrictions": [],
>   "commands": {}
> }
> ```

> **Commands, occurrences and artifacts**
>
> ```json theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
> {
>   "records": {
>     "tickets": {
>       "protocol": "record_observation",
>       "coverage": "incremental_snapshot",
>       "consistency": "observations",
>       "atomicity": "record",
>       "history": "observations",
>       "recordRefresh": false,
>       "reconciliation": false,
>       "notifications": true,
>       "snapshotMaxRows": "100",
>       "profile": {
>         "movement": {
>           "exchanges": {
>             "tickets": {
>               "200": {
>                 "placement": "retained_bytes",
>                 "interpretation": "json",
>                 "projectsBeforeRetention": false,
>                 "retainedBodyLimitBytes": "524288",
>                 "fileLimitBytes": null
>               },
>               "400": {
>                 "placement": "retained_bytes",
>                 "interpretation": "opaque",
>                 "projectsBeforeRetention": false,
>                 "retainedBodyLimitBytes": "524288",
>                 "fileLimitBytes": null
>               },
>               "429": {
>                 "placement": "retained_bytes",
>                 "interpretation": "opaque",
>                 "projectsBeforeRetention": false,
>                 "retainedBodyLimitBytes": "524288",
>                 "fileLimitBytes": null
>               }
>             }
>           },
>           "nativeInputLimitBytes": null,
>           "steps": [
>             {
>               "id": "acquire.1",
>               "inputs": [],
>               "action": {
>                 "operation": "acquire",
>                 "subject": "exchange tickets",
>                 "limitBytes": null
>               }
>             },
>             {
>               "id": "acquire.2",
>               "inputs": [],
>               "action": {
>                 "operation": "acquire",
>                 "subject": "listener changes",
>                 "limitBytes": null
>               }
>             },
>             {
>               "id": "retain.1",
>               "inputs": [
>                 "acquire.1",
>                 "acquire.2"
>               ],
>               "action": {
>                 "operation": "retain",
>                 "subject": "acquisition evidence",
>                 "reason": "recovery",
>                 "release": "acquisition_custody"
>               }
>             },
>             {
>               "id": "interpret.1",
>               "inputs": [
>                 "retain.1"
>               ],
>               "action": {
>                 "operation": "interpret",
>                 "subject": "acquired input",
>                 "produces": "records"
>               }
>             },
>             {
>               "id": "materialize.1",
>               "inputs": [
>                 "interpret.1"
>               ],
>               "action": {
>                 "operation": "materialize",
>                 "subject": "source rows",
>                 "reason": "serving",
>                 "release": "replacement"
>               }
>             },
>             {
>               "id": "publish.1",
>               "inputs": [
>                 "materialize.1"
>               ],
>               "action": {
>                 "operation": "publish",
>                 "subject": "source rows",
>                 "visibility": "with_acquisition"
>               }
>             }
>           ]
>         },
>         "initial": "current_membership",
>         "changes": "observations",
>         "deletions": "scope_membership",
>         "resume": "opaque_cursor",
>         "retentionMs": null,
>         "gap": "explicit_repair",
>         "limits": {
>           "http_response_bytes": "524288",
>           "initial_rows": "100"
>         },
>         "restrictions": [],
>         "commands": {}
>       }
>     }
>   },
>   "occurrences": null,
>   "artifacts": {
>     "raw_archive": false,
>     "native_file_transfer_limit_bytes": null,
>     "external_versions": false,
>     "files": {}
>   },
>   "commands": {}
> }
> ```

**Recorded checks**

| Requirement | Scope | Evidence | Result |
| - | - | - | - |
| listener-custody-before-ack | \{"kind":"listener","collection":"tickets"} | This packaged declaration has not been qualified against a live provider. | Execution result unavailable |
| listener-duplicate-delivery | \{"kind":"listener","collection":"tickets"} | This packaged declaration has not been qualified against a live provider. | Execution result unavailable |
| incremental-token-reset | \{"kind":"collection","name":"tickets"} | Fixture: ./src/connectors/zendesk/fixtures/reset.json | passed (2026-10-24T21:36:12.567Z) |
| page-publication-recovery | \{"kind":"collection","name":"tickets"} | This packaged declaration has not been qualified against a live provider. | Execution result unavailable |
| stated-cursor-empty-page-advances | \{"kind":"collection","name":"tickets"} | Fixture: ./src/connectors/zendesk/fixtures/empty-continue.json | passed (2026-10-24T21:36:12.568Z) |
| stated-cursor-empty-page-advances | \{"kind":"collection","name":"tickets"} | Fixture: ./src/connectors/zendesk/fixtures/empty-complete.json | passed (2026-10-24T21:36:12.569Z) |
| stated-cursor-empty-page-advances | \{"kind":"collection","name":"tickets"} | Fixture: ./src/connectors/zendesk/fixtures/retain-committed.json | passed (2026-10-24T21:36:12.570Z) |
| stated-cursor-empty-page-advances | \{"kind":"collection","name":"tickets"} | Fixture: ./src/connectors/zendesk/fixtures/initial-held.json | passed (2026-10-24T21:36:12.572Z) |
| stated-cursor-repeat-refused | \{"kind":"collection","name":"tickets"} | Fixture: ./src/connectors/zendesk/fixtures/repeat-refused.json | passed (2026-10-24T21:36:12.573Z) |
| identity-account | \{"kind":"connection"} | Fixture: ./src/connectors/zendesk/fixtures/identity.json | passed (2026-10-24T21:36:12.574Z) |

Hosted qualification: **unestablished for this catalog configuration**. Installed connections report their own identity, authority and current status.

## Provider guidance

Cursor incremental ticket export. The provider exclusion window is sixty
seconds. Explicit deleted rows withdraw tickets. A terminal page may retain an
already committed cursor; an initial terminal page without a cursor is held
without changing the serving publication. HTTP 400 resets an existing cursor;
other failures cannot discard it.

Compiled declaration examples and configuration details are published in the [connector reference](https://docs.bijection.com/integrations/connectors/index).

Configure the typed setup fields with `bind` and keep credentials in native
credential custody. Use `zendesk.credential("inventory-name")` for a private
credential reference.

Compiled declaration examples and configuration details are published in the [connector reference](https://docs.bijection.com/integrations/connectors/index).

Package replay is not live qualification. See the generated catalog for exact
declared scenarios and evidence status.

## Provider references

Provider references and prerequisites are maintained in the connector guidance above. No separate provider-documentation review date is recorded.

## Source and evidence

[Canonical connector source](https://github.com/bijectionhq/component-support/blob/b632604330ce9cbcfe17a5a680ef4fbe80f6f672/packages/connectors/src/connectors/zendesk/README.md), [native analysis](https://github.com/bijectionhq/component-support/blob/b632604330ce9cbcfe17a5a680ef4fbe80f6f672/packages/connectors/contract-analysis.json) and [check receipts](https://github.com/bijectionhq/component-support/blob/b632604330ce9cbcfe17a5a680ef4fbe80f6f672/packages/connectors/evidence.json).

Connector artifact: `905888ea276a2a28e36981a79e8142b2547ea451c3e63162cb6915ad4a7d1305`.

The resource declaration examples above are compiled and compared with exact catalog declarations. Recorded checks apply only to their source, declaration and runtime identities. Configure a connection and inspect its status to establish deployment-specific readiness.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.