vPlan
  1. Endpoints
vPlan
  • General
    • Structure
    • Synchronize Data
    • Pagination
    • Sorting
    • Filtering
    • Show & Hide
    • Eager Loading
    • Deep Insertion
    • Deprecated
    • External Reference
    • Rate Limits
    • Authentication
      • Authentication
        • Get authorization
        • Token Exchange
      • Me
        • Retrieve information about current authentication
    • Errors
      • Empty values in created object
      • Memory Exhausted
      • Report an issue
      • Service Unavailable
      • Retrieve Api Messages
  • Endpoints
    • Base Data
      • Board
        • Label
        • Status
        • Capacity
          • Capacity Stage
          • Capacity Resource Type Stage
          • Capacity Resource
          • Capacity Group
        • Retrieve Board List
        • Create New Board
        • Retrieve Single Board
        • Update Single Board
        • Remove Single Board
      • Stage
        • Retrieve Stage List
        • Create New Stage
        • Retrieve Single Stage
        • Update Single Stage
        • Remove Single Stage
      • Activity
        • Retrieve Activity List
        • Create New Activity
        • Retrieve Single Activity
        • Update Single Activity
        • Remove Single Activity
      • Resource
        • Retrieve Resource List
        • Create New Resource
        • Retrieve Single Resource
        • Update Single Resource
        • Remove Single Resource
      • Schedule
        • Retrieve Schedule List
        • Retrieve Schedule Year
        • Retrieve Schedule Month
        • Schedule Retrieve Day
      • Group
        • Retrieve Group List
        • Create New Group
        • Retrieve Single Group
        • Update Single Group
        • Remove Single Group
      • User
        • Retrieve User List
        • Retrieve Single User
        • Update Single User
    • Card Data
      • Collection
        • Custom Fields
          • Update Custom Field By Name
          • Delete Custom Field By Name
        • Retrieve Collection List
        • Create New Collection
        • Retrieve Single Collection
        • Update Single Collection
        • Remove Single Collection
        • Move Collection to Backlog
        • Move Collection to Board
      • Card
        • Custom Field
          • Update Custom Field By Name
          • Delete Custom Field By Name
        • Retrieve Card List
        • All Cards List
        • Create New Card
        • Retrieve Single Card
        • Update Single Card
        • Remove Single Card
        • Split Card
      • Attachment
        • Retrieve Attachment List
        • Upload New Attachment
        • Add New Attachment Link
        • Retrieve Single Attachment
        • Remove Single Attachment
      • Comment
        • Retrieve Comment List
        • Create New Comment
        • Retrieve Single Comment
        • Update Single Comment
        • Remove Single Comment
      • Checklist
        • Collection
          • Retrieve Collection Checklist List
          • Create New Collection Checklist
          • Retrieve Single Collection Checklist
          • Update Single Collection Checklist
          • Remove Single Collection Checklist
        • Card
          • Retrieve Card Checklist List
          • Create New Card Checklist
          • Retrieve Single Card Checklist
          • Update Single Card Checklist
          • Remove Single Card Checklist
      • Time Tracking
        • Retrieve TimeTracking List
        • Create New TimeTracking
        • Retrieve Single TimeTracking
        • Update Single TimeTracking
        • Remove Single TimeTracking
        • Export TimeTracking
      • Relations between cards
        • Retrieve CardRelation List
        • Create New CardRelation
        • Retrieve Single CardRelation
        • Remove Single CardRelation
    • Order Data
      • Address
      • Order
        • Retrieve Order List
        • Create New Order
        • Retrieve Single Order
        • Update Single Order
        • Remove Single Order
      • Row
        • Retrieve OrderRow List
        • Create New OrderRow
        • Retrieve Single OrderRow
        • Update Single OrderRow
        • Remove Single OrderRow
      • Item
        • Retrieve Item List
        • Create New Item
        • Retrieve Single Item
        • Update Single Item
        • Remove Single Item
      • Project
        • Retrieve Project List
        • Create New Project
        • Retrieve Single Project
        • Update Single Project
        • Remove Single Project
      • Relation
        • Retrieve Relation List
        • Create New Relation
        • Retrieve Single Relation
        • Update Single Relation
        • Remove Single Relation
      • Warehouse
        • Retrieve Warehouse List
        • Create New Warehouse
        • Retrieve Single Warehouse
        • Update Single Warehouse
        • Remove Single Warehouse
    • Webhook
      • Retrieve Webhook List
      • Create New Webhook
      • Retrieve Single Webhook
      • Update Single Webhook
      • Remove Single Webhook
    • Payload send to webhook url
      • Normal Object
      • Nested Object
      • Nested Object with Pivot
  1. Endpoints

Webhook

Webhooks can be used to get a signal from our servers if a certain event is triggered.
Instead of retrieving objects for example every 30 minutes, and looking for changes.
Webhooks can be used to receive a signal when an action is performed.
There is a wide variety of triggers available.
A webhook can be manually set up via Settings -> Developers in the vPlan web frontend.
Or added programmatically via the POST /webhook
Webhook
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
Modified at 2024-11-21 17:12:57
Previous
Remove Single Warehouse
Next
Retrieve Webhook List
Built with