Formance Webhooks API

Webhook subscription configuration.

Operations 8

GET /api/webhooks/configs Get many configs #
POST /api/webhooks/configs Insert a new config #
PUT /api/webhooks/configs/{id} Update one config #
DELETE /api/webhooks/configs/{id} Delete one config #
PUT /api/webhooks/configs/{id}/activate Activate one config #
PUT /api/webhooks/configs/{id}/deactivate Deactivate one config #
PUT /api/webhooks/configs/{id}/secret/change Change the signing secret of a config #
GET /api/webhooks/configs/{id}/test Test one config #

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.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/formance-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

formance-webhooks-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Formance Platform Webhooks API
  description: Open-source financial infrastructure for money movement.
  termsOfService: https://www.formance.com/terms
  contact:
    name: Formance
    url: https://www.formance.com
  license:
    name: MIT
    url: https://github.com/formancehq/ledger/blob/main/LICENSE
  version: v1
servers:
- url: https://{organization}.{environment}.formance.cloud
  description: Formance Cloud stack host
  variables:
    organization:
      default: sandbox
      description: Your organization / stack slug.
    environment:
      default: eu.sandbox
      description: The Formance Cloud environment / region for the stack.
security:
- oauth2: []
tags:
- name: Webhooks
  description: Webhook subscription configuration.
paths:
  /api/webhooks/configs:
    get:
      operationId: getManyConfigs
      tags:
      - Webhooks
      summary: Get many configs
      responses:
        '200':
          description: Cursor of configs.
    post:
      operationId: insertConfig
      tags:
      - Webhooks
      summary: Insert a new config
      responses:
        '200':
          description: Config created.
  /api/webhooks/configs/{id}:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
    put:
      operationId: updateConfig
      tags:
      - Webhooks
      summary: Update one config
      responses:
        '200':
          description: Config updated.
    delete:
      operationId: deleteConfig
      tags:
      - Webhooks
      summary: Delete one config
      responses:
        '200':
          description: Config deleted.
  /api/webhooks/configs/{id}/activate:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
    put:
      operationId: activateConfig
      tags:
      - Webhooks
      summary: Activate one config
      responses:
        '200':
          description: Config activated.
  /api/webhooks/configs/{id}/deactivate:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
    put:
      operationId: deactivateConfig
      tags:
      - Webhooks
      summary: Deactivate one config
      responses:
        '200':
          description: Config deactivated.
  /api/webhooks/configs/{id}/secret/change:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
    put:
      operationId: changeConfigSecret
      tags:
      - Webhooks
      summary: Change the signing secret of a config
      responses:
        '200':
          description: Secret changed.
  /api/webhooks/configs/{id}/test:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: testConfig
      tags:
      - Webhooks
      summary: Test one config
      responses:
        '200':
          description: Test result.
components:
  securitySchemes:
    oauth2:
      type: oauth2
      description: 'OAuth2 client-credentials flow. Exchange a client id and secret at `/api/auth/oauth/token` for a Bearer access token, then send it as `Authorization: Bearer <token>`.'
      flows:
        clientCredentials:
          tokenUrl: https://{organization}.{environment}.formance.cloud/api/auth/oauth/token
          scopes:
            ledger:read: Read ledger resources
            ledger:write: Write ledger resources
            payments:read: Read payments resources
            payments:write: Write payments resources
            wallets:read: Read wallets resources
            wallets:write: Write wallets resources