Hindsight Cloud Docs

Appearance

Register webhook ​

POST /v1/default/banks/{bank_id}/webhooks

Register a webhook endpoint to receive event notifications for this bank.

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

Path Parameters ​

NameTypeRequiredDescription
bank_idstringYes

Request Body ​

Content-Type: application/json

json
{
  "url": "Url",
  "secret": "string",
  "event_types": [
    "consolidation.completed"
  ],
  "enabled": true,
  "http_config": {
    "method": "POST",
    "timeout_seconds": 30,
    "headers": {},
    "params": {}
  }
}

Example Request ​

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

Responses ​

201 — Successful Response

json
{
  "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

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

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