JobSpecs
A JobSpec defines which ZIS Flow should run when a given event happens. It contains an event source and type, and a reference to the Flow that should be run when that event occurs.
JSON Format
JobSpecs are represented as JSON objects with the following properties:
| Name | Type | Read-only | Mandatory | Description |
|---|---|---|---|---|
| job_specs | array | false | false |
Install JobSpec
POST /api/services/zis/registry/job_specs/install?job_spec_name={job_spec_name}
Installs a JobSpec for a Zendesk account. The account is inferred from the subdomain.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
| job_spec_name | string | Query | true | The name of the job spec |
Using cURL
curl https://{subdomain}.zendesk.com/api/services/zis/registry/job_specs/install?job_spec_name={job_spec_name} \-H "Authorization: Bearer {access_token}" \-X POST
Example Response
Status 200 OK
Uninstall JobSpec
DELETE /api/services/zis/registry/job_specs/install?job_spec_name={job_spec_name}
Uninstalls a JobSpec for an account. The account is inferred from the subdomain.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
| job_spec_name | string | Query | true | The name of the job spec |
Using cURL
curl https://{subdomain}.zendesk.com/api/services/zis/registry/job_specs/install?job_spec_name={job_spec_name} \-H "Authorization: Bearer {access_token}" \-X DELETE
Example Response
Status 204 No Content