How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Bolt Financial Webhooks API

Set up webhooks to notify your backend of events within Bolt. These webhooks can communicate with your OMS or other systems to keep them up to date with Bolt. See our related guide on [Webhooks](https://help.boltapp.com/get-started/during-checkout/webhooks/).

Bolt Financial Webhooks API is one of 13 APIs that Bolt Financial publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Webhook. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 2 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version 1.0.1.

Requests are made against 3 base URLs: https://api.boltapp.com, https://api-sandbox.boltapp.com, https://api-staging.boltapp.com.

4 operations 2 paths 15 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.1
Base URL
https://api.boltapp.com
Authentication
OAuth 2.0, API Key
Resource Areas
1

Authentication & Security 2

Bolt Financial Webhooks API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth) using the authorizationCode flow, exposing 3 scopes. An API key is passed in the header as X-API-Key (X-API-Key). By default, every request must be authenticated.

  • OAuth — Bolt utilizes the OAuth flow that developers can use to attain access to Bolt Account data via APIs. For all APIs that require authorization, please provide yo…
  • X-API-Key — Admins and Developers can obtain their Bolt API key from the Bolt Merchant Dashboard.

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Webhooks 4

Set up webhooks to notify your backend of events within Bolt. These webhooks can communicate with your OMS or other systems to keep them up to date with Bolt. See our related guid…

GET
/v1/webhooks
Query Webhooks
queryWebhooks 1 param → 200400403404
POST
/v1/webhooks
Create Bolt Webhook
createWebhook body → 200400403422
DELETE
/v1/webhooks/{webhook_id}
Delete a Bolt Webhook
deleteWebhook 1 param → 200400403404
GET
/v1/webhooks/{webhook_id}
Get Webhook
getWebhook 1 param → 200400403404

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are webhook (5 properties), errors_bolt_api_response (2 properties), error_bolt_api (2 properties), base_create_webhook (2 properties). Each schema is shown below with its type and property counts.

error_bolt_api
object
Error object containing custom error information
2 properties
message
string
Human-readable description of the error for developers. Should not be shown to users and is not localized.
url
string
The full URL to receive webhook notifications.
request_result
object
Custom-defined Bolt result object.
1 property
events_array_create_webhook
object
1 property
errors_bolt_api
array
webhook
object
5 properties 3 required
base_create_webhook
object
2 properties 2 required
webhook_id
string
A unique webhook ID. Reference this value to modify or delete the webhook subscription. operations as well.
webhook_event_group
stringnull
Subscribe to a group of events. all: subscribe to all existing and future event types
errors_bolt_api_response
object
2 properties
code
integer
Custom-defined Bolt error code. This can be used to programmatically react to specific errors.
event_group_create_webhook
object
1 property
webhooks_type
string
[Webhook events](https://help.boltapp.com/developers/guides/webhooks/transaction-hook-types) that trigger a notification to the URL. Note:newslettersubscriptio…
request_failed
boolean
Indicates that the request failed. This value is always false.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bolt-financial-webhooks-api-openapi.yml Raw ↑

Other APIs Bolt Financial publishes across the network.

Bolt MCP Servers
Bolt Financial Account API
Bolt Financial Callbacks API
Bolt Financial Configuration API
Bolt Financial O Auth API
Bolt Financial Orders API
Bolt Financial Payments API
Bolt Financial Statements API
Bolt Financial Subscriptions API
Bolt Financial Testing API
Bolt Financial Tokenizer API
Bolt Financial Transactions API
Where this information came from

This is an independent, third-party profile of Bolt Financial Webhooks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.