Website

key

string

The unique identifier for the job.

actions

array of objects

Actions that occurred within a job (Only for single job requests).

key

string

The unique identifier for the job action.

eventKey

string

The type of event for the integration.

integrationKey

string

The unique identifier for the integration.

status

enum

The status of the action. Options include: done, failed, proc, received.

logs

array of objects

The log for each attempted delivery of the action.

status

integer

The HTTP response status received.

timestamp

ISO 8601 date string

The date when the response was received.

reason

string or null

When failed, the optional reason provided.

scheduledAt

string or null

Present when failed and automatic retry is available. The next scheduled delivery date.

activeSteps

array of objects

The list of steps that are currently active on the job.

key

string

The unique identifier for the step.

name

string

The name of the name.

activeWorkflows

array of objects

The list of workflows that are currently active on the job.

key

string

The unique identifier for the workflow.

name

string

The name of the workflow.

assignedTo

array of objects

The list of users that are currently assigned to steps on the job.

key

string

The unique identifier for the user.

firstName

string

The first name of the user.

lastName

string

The last name of the user.

completedAt

ISO 8601 date string or null

When the job was completed (or null if not complete).

content

object

The user-generated content captured during the job (Only for single job requests).

fields

array of objects

The form fields completed during the job.

key

string

The unique identifier for the field.

name

string

The name of the field.

type

string

The type of field.

value

string

The user-provided value during the job.

logs

array of objects

The events that occurred during the job (Only for single job requests).

workflowKey

string

The unique identifier for the workflow.

elementKey

string

The unique identifier for the workflow element.

elementType

string

The type of workflow element, such as step, action.

event

string

The identifier for the type of job event that occurred.

details

object

Extra details about the job event, for example, a userKey is present on the event user_step_completed.

timestamp

string

The date when the job event was logged.

startedAt

ISO 8601 date string

When the job started.

startedBy

object

The user who created the job.

key

string

The unique identifier for the user.

firstName

string

The first name of the user.

lastName

string

The last name of the user.

steps

array of objects

The steps that are included in the job (Only for single job requests).

key

string

The unique identifier for the job step.

step

object

The workflow step details.

key

string

The unique identifier for the workflow step.

name

string

The name of the step.

workflow

object

The workflow details.

key

string

The unique identifier for the workflow.

name

string

The name of the workflow.

completedBy

array of objects

A list of users who completed the job step.

key

string

The unique identifier for the user.

firstName

string

The first name of the user.

lastName

string

The last name of the user.

completedAt

ISO 8601 date string or null

When the step was completed (or null if not complete).

updatedAt

ISO 8601 date string

When the job was last updated.

Resources

Workflows

Users

Roles

Jobs

Form fields

Resources

Workflows

Users

Roles

Jobs

Form fields

Resources

Workflows

Users

Roles

Jobs

Form fields

Jobs

Schema Overview

Resources

Workflows

Users

Roles

Jobs

Form fields