A Bundle is a declaration of the ZIS resources that make up your integration, such as Flows, Action definitions, and JobSpecs.

JSON Format

Bundles are represented as JSON objects with the following properties:

Name Type Read-only Mandatory Description
description string true false The description of the Bundle
name string false true The name of the Bundle
resources object true true A collection of ZIS resources
zis_template_version string false true The ZIS Bundle template version. Allowed value of "2019-10-14".

Upload or Update Bundle

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

Uploads a new bundle or updates an existing bundle to the ZIS Registry. This supports Basic Authentication and API Token.


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": "this is an example bundle",  "name": "example bundle",  "resources": {    "example_flow": {      "properties": {        "definition": {          "StartAt": "HelloWorld",          "States": {            "HelloWorld": {              "End": true,              "Result": "Hello World!",              "ResultPath": "$.messages",              "Type": "Pass"            }          }        },        "name": "my_flow"      },      "type": "ZIS::Flow"    },    "example_job_spec": {      "properties": {        "event_source": "support",        "event_type": "ticket.TicketCreated",        "flow_name": "zis:example:flow:my_flow",        "name": "my_job_Spec"      },      "type": "ZIS::JobSpec"    }  },  "zis_template_version": "2019-10-14"}

Using cURL

curl https://{subdomain}.zendesk.com/api/services/zis/registry/{integration}/bundles \-u {email_address}:{password} \-X POST \-H "Content-Type: application/json" \-d @bundle.json

Example Response

Status 200 OK