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.
Authentication
You can authorize requests using basic authentication, an API token, or a ZIS OAuth access token. A Zendesk app can also authorize requests to this endpoint using an admin's browser session. See Making API requests from a Zendesk app.
Allowed for
- Admins
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} \
-u {email_address}:{password} \
-X POST
Example Response(s)
200 OK
Status 200 OK
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"
}
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.
Authentication
You can authorize requests using basic authentication, an API token, or a ZIS OAuth access token. A Zendesk app can also authorize requests to this endpoint using an admin's browser session. See Making API requests from a Zendesk app.
Allowed for
- Admins
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} \
-u {email_address}:{password} \
-X DELETE
Example Response(s)
204 No Content
Status 204 No Content
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"
}
404 Not Found
Status 404 Not Found
{
"errors": [
{
"code": "1020",
"detail": "error message",
"status": "400"
}
],
"message": "Missing Resource"
}
500 Internal Server Error
Status 500 Internal Server Error
{
"errors": [
{
"code": "1050",
"detail": "error message",
"status": "500"
}
],
"message": "Server Error"
}