List webhook endpoints

GET

/api/v1/webhooks

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

• Digize

The endpoints the workspace sends events to, with how their deliveries are going.

Needs the settings:write permission.

Authorizations

• apiKey
• bearer

Responses

200

Done

Media typeapplication/json

object

data

required

Array<object>

object

id

required

string

url

required

string

events

required

Array<string>

description

required

string | null

source

required

zapier for a REST hook subscription made through /hooks.

string

Allowed values: api zapier

createdBy

required

string

createdAt

required

string format: date-time

disabledAt

required

Any of:

string

string format: date-time

null

null

failures

required

Attempts that failed since the last one that got through.

integer

<= 9007199254740991

lastDeliveryAt

required

Any of:

string

string format: date-time

null

null

Example

{
  "data": [
    {
      "source": "api"
    }
  ]
}

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"
  }
}