Create New Webhook

Request

Header Params

x-api-key

string

required

Default:

x-api-env

string

required

Default:

Body Params application/json

url

string <uri>

required

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

enum<string>

WebhookEventTypeNormal

optional

Allowed values:

card.createdcard.updatedcard.deletedcard.updated.mergedcollection.createdcollection.updatedcollection.deletedattachment.createdattachment.updatedattachment.deletedcomment.createdcomment.updatedcomment.deletedtime_tracking.createdtime_tracking.updatedtime_tracking.deleted

enum<string>

WebhookEventTypeNested

optional

Allowed values:

card.label.attachedcard.label.detachedcard.resource.attachedcard.resource.detachedcollection.label.attachedcollection.label.detachedcollection.follower.attachedcollection.follower.detached

enum<string>

WebhookEventTypeNestedPivot

optional

Allowed values:

card.activity.attachedcard.activity.detachedcard.activity.updatedcollection.activity.attachedcollection.activity.detachedcollection.activity.updatedcollection.checklist.createdcollection.checklist.updatedcollection.checklist.deletedcollection.checklist.item.attachedcollection.checklist.item.detachedcollection.checklist.item.updated

Example

{
    "url": "http://example.com",
    "description": "string",
    "active": true,
    "event_types": [
        "card.created"
    ]
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.vplan.com/v1/webhook' \
--header 'x-api-key;' \
--header 'x-api-env;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "http://example.com",
    "description": "string",
    "active": true,
    "event_types": [
        "card.created"
    ]
}'

Responses

🟢201Created

application/json

Body

id

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

enum<string>

WebhookEventTypeNormal

optional

Allowed values:

card.createdcard.updatedcard.deletedcard.updated.mergedcollection.createdcollection.updatedcollection.deletedattachment.createdattachment.updatedattachment.deletedcomment.createdcomment.updatedcomment.deletedtime_tracking.createdtime_tracking.updatedtime_tracking.deleted

enum<string>

WebhookEventTypeNested

optional

Allowed values:

card.label.attachedcard.label.detachedcard.resource.attachedcard.resource.detachedcollection.label.attachedcollection.label.detachedcollection.follower.attachedcollection.follower.detached

enum<string>

WebhookEventTypeNestedPivot

optional

Allowed values:

card.activity.attachedcard.activity.detachedcard.activity.updatedcollection.activity.attachedcollection.activity.detachedcollection.activity.updatedcollection.checklist.createdcollection.checklist.updatedcollection.checklist.deletedcollection.checklist.item.attachedcollection.checklist.item.detachedcollection.checklist.item.updated

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:

0

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

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

🟠422Unprocessable Content

🟠401Not Logged In