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

Brale Webhooks API

The Webhooks API from Brale — 6 operation(s) for webhooks.

Brale Webhooks API is one of 6 APIs that Brale 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, API documentation, an API reference, and a getting-started guide.

This API exposes 8 operations across 6 paths, and defines 18 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api.brale.xyz.

8 operations 6 paths 18 schemas 1 DELETE4 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.brale.xyz
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

Brale Webhooks API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth) using the clientCredentials flow, exposing 11 scopes.

Paths & Operations 8

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

Webhooks 8
GET
/accounts/{account_id}/webhooks/deliveries
List webhook delivery logs
list_webhook_deliveries 2 params → 200400401403404
DELETE
/accounts/{account_id}/webhooks/subscriptions/{subscription_id}
Archive webhook subscription
delete_webhook_subscription 2 params → 204401403404409
PATCH
/accounts/{account_id}/webhooks/subscriptions/{subscription_id}
Update webhook subscription
update_webhook_subscription 2 params body → 200400401403404409422
GET
/accounts/{account_id}/webhooks/{subscription_id}
Get webhook subscription
get_webhook_subscription 2 params → 200401403404
GET
/accounts/{account_id}/webhooks
List webhook subscriptions
list_webhook_subscriptions 1 param → 200401403404
POST
/accounts/{account_id}/webhooks
Create webhook subscription
create_webhook_subscription 1 param body → 201400401403404422
POST
/accounts/{account_id}/webhooks/events/{event_id}/resend
Replay webhook deliveries for an event
replay_webhook_event 2 params → 202400401403404503
GET
/accounts/{account_id}/webhooks/event_types
List supported webhook event types
list_webhook_event_types 1 param → 200401403404

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are ApiError (8 properties), WebhookDeliveryLog (7 properties), WebhookSubscriptionCreated (5 properties), ApiErrorV2 (5 properties). Each schema is shown below with its type and property counts.

DateTime
string
ISO-8601 timestamp that includes date and time
Failure
object
3 properties 1 required
WebhookDeliveryLog
object
7 properties 6 required
WebhookEventTypeList
object
1 property 1 required
ID
string
ID of the resource
WebhookSubscriptionList
object
1 property 1 required
ApiErrorV2
object
5 properties 1 required
Pagination
object
Pagination information for list endpoints
3 properties
CreateWebhookSubscription
object
2 properties 2 required
UpdateWebhookSubscription
object
2 properties
PagingParameters
object
Paging query parameters
3 properties
WebhookEventType
object
2 properties 2 required
WebhookDeliveryLogList
object
2 properties 2 required
Link
object
1 property 1 required
ApiError
object
8 properties
WebhookReplayAccepted
object
2 properties 2 required
WebhookSubscriptionCreated
object
5 properties 5 required
WebhookSubscription
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

brale-webhooks-api-openapi.yml Raw ↑

Other APIs Brale publishes across the network.

Brale Accounts API
Brale Addresses API
Brale Automations API
Brale Financial Institutions API
Brale Orders API
Where this information came from

This is an independent, third-party profile of Brale 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.