The Integrations API provides an endpoint to register an integration of another system with ZIS. This enables you to create ZIS resources and workflows.

JSON format

Integrations are represented as JSON objects with the following properties:

Name Type Read-only Mandatory Description
description string true false The description of the integration
jwt_public_key string true false The public key of the JWT
zendesk_oauth_client object false false

Create Integration

  • POST /api/services/zis/registry/{integration}

Creates an integration using the specified integration parameter.


You can authorize requests using basic authentication or an API token.

Allowed for

  • Admins

Deleting an integration

You can't delete an integration. However, you can disable it by uninstalling its JobSpec. See the Uninstall JobSpec endpoint.


Name Type In Required Description
integration string Path true The name of the integration. integration can be up to 64 characters long. It can only include lower-case letters (a-z), numbers, dash (-), and underscore (_) characters

Example body

{  "description": "example integration"}

Using cURL

curl https://{subdomain}{integration} \-u {email_address}:{password} \-X POST \-H "Content-Type: application/json" \-d '{"description":"example integration"}'

Example response(s)

200 OK
Status 200 OK
{  "description": "example integration",  "jwt_public_key": "The RSA Public Key to be saved",  "zendesk_oauth_client": {    "id": 10066,    "identifier": "zis_my_integration",    "secret": "secret"  }}
400 Bad Request
Status 400 Bad Request
{  "errors": [    {      "code": "1010",      "detail": "error message",      "status": "400"    }  ],  "message": "Unauthorized"}
401 Unauthorized
Status 401 Unauthorized
{  "errors": [    {      "code": "1001",      "detail": "error message",      "status": "401"    }  ],  "message": "Unauthorized"}
500 Internal Server Error
Status 500 Internal Server Error
{  "errors": [    {      "code": "1050",      "detail": "error message",      "status": "500"    }  ],  "message": "Server Error"}