Update webhook

PATCH /v1/default/banks/{bank_id}/webhooks/{webhook_id}

Update one or more fields of a registered webhook. Only provided fields are changed.

Authentication required — include an Authorization: Bearer hsk_... header. See Authentication for details.

Path Parameters

Name	Type	Required	Description
bank_id	string	Yes
webhook_id	string	Yes

Request Body

Content-Type: application/json

{
  "url": "string",
  "secret": "string",
  "event_types": [
    "string"
  ],
  "enabled": false,
  "http_config": {
    "method": "POST",
    "timeout_seconds": 30,
    "headers": {},
    "params": {}
  }
}

Example Request

curl -X PATCH 'https://api.hindsight.vectorize.io/v1/default/banks/your-bank-id/webhooks/your-webhook-id' \
  -H 'Authorization: Bearer hsk_your_api_key' \
  -H 'Content-Type: application/json' \
  -d '{
    "url": "string",
    "secret": "string",
    "event_types": [
      "string"
    ],
    "enabled": false,
    "http_config": {
      "method": "POST",
      "timeout_seconds": 30,
      "headers": {},
      "params": {}
    }
  }'

Responses

200 — Successful Response

{
  "id": "Id",
  "bank_id": "string",
  "url": "Url",
  "secret": "string",
  "event_types": [
    "string"
  ],
  "enabled": false,
  "http_config": {
    "method": "POST",
    "timeout_seconds": 30,
    "headers": {},
    "params": {}
  },
  "created_at": "string",
  "updated_at": "string"
}

422 — Validation Error

{
  "detail": [
    {
      "loc": [
        null
      ],
      "msg": "Message",
      "type": "Error Type",
      "input": null,
      "ctx": {},
      "url": "URL"
    }
  ]
}

---

Source: /v1/default/banks/{bank_id}/webhooks/{webhook_id}