Retrieve Webhook List

Retrieve the Webhook List

Request

Query Params

limit

integer

optional

Number of maximum records given. More info pagination

Default:

100

offset

integer

optional

Number of records to be skipped. More info pagination

Default:

filter

string

optional

Filter the dataset. More info filtering

sort

string

optional

Sorting the dataset. More info sorting

show

string

optional

Show only specific properties from the response. More info show & hide

hide

string

optional

Hide properties from the response. More info show & hide

with

string

optional

Object(s) included in the dataset. More info eager loading

Header Params

x-api-key

string

required

Default:

x-api-env

string

required

Default:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Ok

application/json

Body

count

integer <uint64>

optional

Total amount of items

>= 0

Default:

limit

integer <uint64>

optional

Max amount of items fetched

>= 0<= 1000

Default:

100

offset

integer <uint64>

optional

Offset so items may be paginated

>= 0

Default:

data

array[object (Webhook) {17}]

optional

Items

string <uuid>

read-onlyoptional

Unique identifier

url

string <uri>

optional

The url where the event is send to

NOTE

this url must be publically available

self signed certificates are not supported

<= 512 characters

description

string

optional

<= 150 characters

active

boolean

optional

event_types

array[null (WebhookEventType Copy) {3}]

optional

Array of all event that are send to the url

api_key_id

string

read-onlyoptional

If the webhook is created via an api key, the id of that api key is shown here.

To look up your api_key id look at the /me endpoint

<= 36 characters

Default:

NULL

developer_client_id

string

read-onlyoptional

If the webhook is created via an oAuth connection, the client id of the oAuth app is shown here

<= 36 characters

Default:

NULL

third_party

boolean

read-onlyoptional

True if the webhook is created via API Key or oAuth

fail_streak

integer | null

read-onlyoptional

Number of last consecutive failed attempts

>= 0<= 4294967296

Default:

fail_streak_started_at

string <date-time> | null

read-onlyoptional

Date and time the current fail streak started

last_failed_at

string <date-time> | null

read-onlyoptional

Date and time of the last failed attempt of the current fail streak

mailed_warning_at

string <date-time> | null

read-onlyoptional

Date and time when the warning mail was sent to the administrators

mailed_disabled_at

string <date-time> | null

read-onlyoptional

Date and time the disabled notify mail was sent to the administrators

disabled_until

string <date-time> | null

read-onlyoptional

Date and time indicating a temporarily disabled a webhook

can_send

boolean

read-onlyoptional

False if the webhook had too many consecutive failed attempts or was temporarily disabled. When false, events will be suspended and are not send out automatically.

created_at

string <date-time>

read-onlyoptional

Date and time of creation

updated_at

string <date-time>

read-onlyoptional

Date and time of last update

Example

{
    "count": 1,
    "limit": 100,
    "offset": 0,
    "data": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "url": "http://example.com",
            "description": "string",
            "active": true,
            "event_types": [
                "card.created"
            ],
            "api_key_id": "NULL",
            "developer_client_id": "NULL",
            "third_party": true,
            "fail_streak": "0",
            "fail_streak_started_at": "2019-08-24T14:15:22Z",
            "last_failed_at": "2019-08-24T14:15:22Z",
            "mailed_warning_at": "2019-08-24T14:15:22Z",
            "mailed_disabled_at": "2019-08-24T14:15:22Z",
            "disabled_until": "2019-08-24T14:15:22Z",
            "can_send": true,
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z"
        }
    ]
}

🟠401Not Logged In