Create New Webhook

POST

/webhook

Create a new Webhook and store it

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

API Key

Add parameter in header

x-api-env

Example:

x-api-env: ********************

Body Params application/json

Example

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

Responses

🟢201Created

application/json

Body

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

🟠401Not Logged In

Modified at 2025-10-30 09:44:22

Retrieve Webhook List

Retrieve Single Webhook