Get Automations settings

GET

/api/v1/automations/settings

curl --request GET \
  --url https://digize.com/api/v1/automations/settings \
  --header 'x-api-key: <x-api-key>'

• Digize

How every workflow runs: time limit, retries, what’s kept of runs, failure alerts, the schedules’ time zone and webhooks.

Needs the automations:read permission.

Authorizations

• apiKey
• bearer

Responses

200

Done

Media typeapplication/json

object

timeoutMinutes

required

integer

>= 1 <= 60

retries

required

integer

<= 5

saveRunData

required

string

Allowed values: all errors none

retentionDays

required

integer

>= 1 <= 90

errorWorkflowId

required

Any of:

string

string

<= 64 characters

null

null

timezone

required

Any of:

string

string

<= 64 characters

null

null

concurrency

required

integer

>= 1 <= 50

notifyByEmail

required

boolean

notifyEmails

required

Array<string>

<= 20 items

notifyBySlack

required

boolean

slackCredentialId

required

Any of:

string

string

<= 64 characters

null

null

slackChannel

required

string

<= 80 characters

webhookBaseUrl

required

Webhook triggers listen at this address followed by their path.

string

signingSecret

required

Any of:

object

object

hint

required

string

createdAt

required

string format: date-time

null

null

Example

{
  "saveRunData": "all"
}

400

What was sent isn’t valid (invalid).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}