Update webhook endpoint - Veri Documentation

PATCH

/

v1

/

webhooks

/

{webhook_id}

Update webhook endpoint

curl --request PATCH \
  --url https://api.veri.studio/v1/webhooks/{webhook_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "description": "<string>",
  "event_types": [
    "<string>"
  ],
  "enabled": true
}
'

import requests

url = "https://api.veri.studio/v1/webhooks/{webhook_id}"

payload = {
    "url": "<string>",
    "description": "<string>",
    "event_types": ["<string>"],
    "enabled": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: '<string>',
    description: '<string>',
    event_types: ['<string>'],
    enabled: true
  })
};

fetch('https://api.veri.studio/v1/webhooks/{webhook_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "object": "<string>",
  "id": "<string>",
  "url": "<string>",
  "secret": "<string>",
  "event_types": [
    "<string>"
  ],
  "consecutive_failures": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "disabled_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

API key with the vk_ prefix. Create one from the dashboard.

Path Parameters

webhook_id

string

required

Webhook endpoint ID

Body

application/json

url

string | null

description

string | null

event_types

string[] | null

enabled

boolean | null

true re-enables an auto-disabled endpoint (clears disabled_at and the consecutive-failure counter); false disables it.

Response

The updated endpoint (secret masked)

object

string

required

id

string

required

url

string

required

secret

string

required

Full "whsec_..." signing secret on create ONLY; masked on every other read (use GET /v1/webhooks/{id}/secret to retrieve it again).

event_types

string[]

required

Empty = subscribed to all event types.

consecutive_failures

integer<int32>

required

created_at

string<date-time>

required

updated_at

string<date-time>

required

description

string | null

disabled_at

string<date-time> | null

Set when the endpoint is disabled (manually or automatically after 50 consecutive delivery failures). Disabled endpoints receive no events.

Update webhook endpoint

curl --request PATCH \
  --url https://api.veri.studio/v1/webhooks/{webhook_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "description": "<string>",
  "event_types": [
    "<string>"
  ],
  "enabled": true
}
'

import requests

url = "https://api.veri.studio/v1/webhooks/{webhook_id}"

payload = {
    "url": "<string>",
    "description": "<string>",
    "event_types": ["<string>"],
    "enabled": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: '<string>',
    description: '<string>',
    event_types: ['<string>'],
    enabled: true
  })
};

fetch('https://api.veri.studio/v1/webhooks/{webhook_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "object": "<string>",
  "id": "<string>",
  "url": "<string>",
  "secret": "<string>",
  "event_types": [
    "<string>"
  ],
  "consecutive_failures": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "disabled_at": "2023-11-07T05:31:56Z"
}