Update Single Webhook

Request

Path Params

webhook_id

string <uuid>

required

Header Params

x-api-key

string

required

Default:

x-api-env

string

required

Default:

Body Params application/json

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

Example

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PUT 'https://api.vplan.com/v1/webhook/' \
--header 'x-api-key;' \
--header 'x-api-env;' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢204No Content

text/plain

Body

object {0}

🟠422Unprocessable Content

🟠404Not Found

🟠401Not Logged In