betteroff-finance Outbound Webhooks API
The outbound-webhooks API from betteroff-finance — 6 operation(s) for outbound-webhooks.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/betteroff-finance:betteroff-finance-outbound-webhooks-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: BetterOff Outbound Webhooks API
version: 0.5.0+cd65185c
servers:
- url: https://api.betteroff.finance
tags:
- name: outbound-webhooks
paths:
/outbound-webhooks/endpoints:
get:
operationId: getOutboundWebhooksEndpoints
tags:
- outbound-webhooks
security:
- session: []
responses:
'200':
description: Success
content:
application/json:
schema:
$schema: https://json-schema.org/draft/2020-12/schema
type: object
properties:
endpoints:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
url:
type: string
format: uri
events:
type: array
items:
type: string
enum:
- transaction.created
- balance.changed
- action_request.pending
- connection.created
- connection.removed
- connection.needs_reauth
description: Events to deliver. Each is delivered within five minutes of the change.
disabledAt:
anyOf:
- type: string
format: date-time
pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
- type: 'null'
consecutiveFailures:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
createdAt:
type: string
format: date-time
pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
required:
- id
- url
- events
- disabledAt
- consecutiveFailures
- createdAt
additionalProperties: false
required:
- endpoints
additionalProperties: false
default:
description: Problem details
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
summary: Get outbound webhooks endpoints
x-summary-source: derived
post:
operationId: postOutboundWebhooksEndpoints
tags:
- outbound-webhooks
security:
- session: []
requestBody:
required: true
content:
application/json:
schema:
$schema: https://json-schema.org/draft/2020-12/schema
type: object
properties:
url:
type: string
maxLength: 2048
events:
minItems: 1
maxItems: 6
type: array
items:
type: string
enum:
- transaction.created
- balance.changed
- action_request.pending
- connection.created
- connection.removed
- connection.needs_reauth
required:
- url
- events
additionalProperties: false
responses:
'201':
description: Success
content:
application/json:
schema:
$schema: https://json-schema.org/draft/2020-12/schema
type: object
properties:
endpoint:
type: object
properties:
id:
type: string
format: uuid
pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
url:
type: string
format: uri
events:
type: array
items:
type: string
enum:
- transaction.created
- balance.changed
- action_request.pending
- connection.created
- connection.removed
- connection.needs_reauth
description: Events to deliver. Each is delivered within five minutes of the change.
disabledAt:
anyOf:
- type: string
format: date-time
pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
- type: 'null'
consecutiveFailures:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
createdAt:
type: string
format: date-time
pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
required:
- id
- url
- events
- disabledAt
- consecutiveFailures
- createdAt
additionalProperties: false
secret:
type: string
description: Signing secret. Shown once; store it now.
required:
- endpoint
- secret
additionalProperties: false
default:
description: Problem details
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
summary: Post outbound webhooks endpoints
x-summary-source: derived
/outbound-webhooks/endpoints/{id}:
delete:
operationId: deleteOutboundWebhooksEndpointsId
tags:
- outbound-webhooks
security:
- session: []
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$schema: https://json-schema.org/draft/2020-12/schema
type: object
properties: {}
additionalProperties: false
default:
description: Problem details
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
summary: Delete outbound webhooks endpoints id
x-summary-source: derived
/outbound-webhooks/endpoints/{id}/test:
post:
operationId: postOutboundWebhooksEndpointsIdTest
tags:
- outbound-webhooks
security:
- session: []
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$schema: https://json-schema.org/draft/2020-12/schema
type: object
properties:
delivered:
type: boolean
status:
anyOf:
- type: integer
minimum: -9007199254740991
maximum: 9007199254740991
- type: 'null'
error:
type:
- string
- 'null'
required:
- delivered
- status
- error
additionalProperties: false
default:
description: Problem details
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
summary: Post outbound webhooks endpoints id test
x-summary-source: derived
/outbound-webhooks/endpoints/{id}/deliveries:
get:
operationId: getOutboundWebhooksEndpointsIdDeliveries
tags:
- outbound-webhooks
security:
- session: []
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$schema: https://json-schema.org/draft/2020-12/schema
type: object
properties:
deliveries:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
eventId:
type: string
format: uuid
pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
eventType:
type: string
status:
type: string
enum:
- pending
- succeeded
- failed
attempts:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
lastStatusCode:
anyOf:
- type: integer
minimum: -9007199254740991
maximum: 9007199254740991
- type: 'null'
lastError:
type:
- string
- 'null'
createdAt:
type: string
format: date-time
pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
deliveredAt:
anyOf:
- type: string
format: date-time
pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
- type: 'null'
required:
- id
- eventId
- eventType
- status
- attempts
- lastStatusCode
- lastError
- createdAt
- deliveredAt
additionalProperties: false
required:
- deliveries
additionalProperties: false
default:
description: Problem details
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
summary: Get outbound webhooks endpoints id deliveries
x-summary-source: derived
/outbound-webhooks/endpoints/{id}/deliveries/{deliveryId}/redeliver:
post:
operationId: postOutboundWebhooksEndpointsIdDeliveriesDeliveryIdRedeliver
tags:
- outbound-webhooks
security:
- session: []
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: deliveryId
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$schema: https://json-schema.org/draft/2020-12/schema
type: object
properties:
delivered:
type: boolean
status:
anyOf:
- type: integer
minimum: -9007199254740991
maximum: 9007199254740991
- type: 'null'
error:
type:
- string
- 'null'
required:
- delivered
- status
- error
additionalProperties: false
default:
description: Problem details
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
summary: Post outbound webhooks endpoints id deliveries delivery id redeliver
x-summary-source: derived
/outbound-webhooks/endpoints/{id}/enable:
post:
operationId: postOutboundWebhooksEndpointsIdEnable
tags:
- outbound-webhooks
security:
- session: []
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$schema: https://json-schema.org/draft/2020-12/schema
type: object
properties:
endpoint:
type: object
properties:
id:
type: string
format: uuid
pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
url:
type: string
format: uri
events:
type: array
items:
type: string
enum:
- transaction.created
- balance.changed
- action_request.pending
- connection.created
- connection.removed
- connection.needs_reauth
description: Events to deliver. Each is delivered within five minutes of the change.
disabledAt:
anyOf:
- type: string
format: date-time
pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
- type: 'null'
consecutiveFailures:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
createdAt:
type: string
format: date-time
pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
required:
- id
- url
- events
- disabledAt
- consecutiveFailures
- createdAt
additionalProperties: false
required:
- endpoint
additionalProperties: false
default:
description: Problem details
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
summary: Post outbound webhooks endpoints id enable
x-summary-source: derived
components:
schemas:
ProblemDetails:
$schema: https://json-schema.org/draft/2020-12/schema
type: object
properties:
type:
type: string
description: Always "about:blank"; branch on `code`.
title:
type: string
status:
type: integer
minimum: -9007199254740991
maximum: 9007199254740991
detail:
type: string
code:
type: string
description: Stable UPPER_SNAKE code.
error:
type: string
description: Older clients' copy of `detail`.
message:
type: string
description: Older clients' copy of `detail`.
requestId:
description: Diagnostic only; quote it to support.
type: string
instance:
type: string
details:
type: object
propertyNames:
type: string
additionalProperties: {}
required:
- type
- title
- status
- detail
- code
- error
- message
additionalProperties: {}
description: RFC 9457 problem details. Some refusals add fields; ignore ones you don't know.
securitySchemes:
session:
type: http
scheme: bearer
description: 'The BetterOff app acting for its signed-in user. Not available to integrations: Better Auth session tokens and browser session cookies are rejected. Use an API token or agent OAuth.'
apiToken:
type: http
scheme: bearer
description: Personal API token (bo_pat_), created in BetterOff settings with the scopes it may use.
agentOAuth:
type: openIdConnect
openIdConnectUrl: https://app.betteroff.finance/api/auth/.well-known/openid-configuration
description: Agent OAuth grant; the same token and scopes as /mcp.