List webhook endpoints

GET

/webhooks

curl --request GET \
  --url https://shipjay.com/api/v1/webhooks \
  --header 'Authorization: Bearer <token>'

Authorizations

• bearerAuth
  webhooks:manage

Responses

200

Success.

Media typeapplication/json

object

data

required

Array<object>

object

id

required

string

url

required

string

description

required

string | null

event_types

required

Array<string>

enabled

required

boolean

consecutive_failures

required

number

disabled_reason

required

string | null

created_at

required

string

next_cursor

required

string | null

Example ^generated

{
  "data": [
    {
      "id": "example",
      "url": "example",
      "description": "example",
      "event_types": [
        "example"
      ],
      "enabled": true,
      "consecutive_failures": 1,
      "disabled_reason": "example",
      "created_at": "example"
    }
  ],
  "next_cursor": "example"
}

401

Missing or invalid API key.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: validation unauthenticated forbidden not_found conflict insufficient_funds org_suspended spend_limit rate_limited maintenance not_configured upstream internal

message

required

string

details

object

key

additional properties

any

request_id

required

string

Example

{
  "error": {
    "code": "validation"
  }
}

403

The key lacks the required permission, or the account is suspended.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: validation unauthenticated forbidden not_found conflict insufficient_funds org_suspended spend_limit rate_limited maintenance not_configured upstream internal

message

required

string

details

object

key

additional properties

any

request_id

required

string

Example

{
  "error": {
    "code": "validation"
  }
}

404

The resource does not exist.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: validation unauthenticated forbidden not_found conflict insufficient_funds org_suspended spend_limit rate_limited maintenance not_configured upstream internal

message

required

string

details

object

key

additional properties

any

request_id

required

string

Example

{
  "error": {
    "code": "validation"
  }
}

422

The request is not valid. error.details.issues lists the problems.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: validation unauthenticated forbidden not_found conflict insufficient_funds org_suspended spend_limit rate_limited maintenance not_configured upstream internal

message

required

string

details

object

key

additional properties

any

request_id

required

string

Example

{
  "error": {
    "code": "validation"
  }
}

429

Too many requests. Wait Retry-After seconds.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: validation unauthenticated forbidden not_found conflict insufficient_funds org_suspended spend_limit rate_limited maintenance not_configured upstream internal

message

required

string

details

object

key

additional properties

any

request_id

required

string

Example

{
  "error": {
    "code": "validation"
  }
}