dialogbrain-com

dialogbrain-com Webhooks API

The Webhooks API from dialogbrain-com — 5 operation(s) for webhooks.

GitHub OpenAPI

Operations 9

GET /api/v1/webhooks List Webhooks #
POST /api/v1/webhooks Create Webhook #
DELETE /api/v1/webhooks/{webhook_id} Delete Webhook #
PATCH /api/v1/webhooks/{webhook_id}/activate Activate Webhook #
GET /api/v1/webhooks/{webhook_id}/deliveries List Webhook Deliveries #
GET /webhooks/{path} Proxy Webhooks #
DELETE /webhooks/{path} Proxy Webhooks #
POST /webhooks/{path} Proxy Webhooks #
PUT /webhooks/{path} Proxy Webhooks #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/dialogbrain-com/openapi/dialogbrain-com-webhooks-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/dialogbrain-com/json-schema/dialogbrain-com-agent-update-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/dialogbrain-com/json-schema/dialogbrain-com-src-api-v1-tool-schema-widget-update-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/dialogbrain-com/json-schema/dialogbrain-com-src-api-livechat-config-widget-update-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/dialogbrain-com/json-schema/dialogbrain-com-src-api-livechat-config-widget-create-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/dialogbrain-com/json-schema/dialogbrain-com-post-sessions-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/dialogbrain-com/json-schema/dialogbrain-com-trigger-update-request-schema.json

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/dialogbrain-com:dialogbrain-com-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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

dialogbrain-com-webhooks-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: DialogBrain v2 API Gateway Webhooks API
  description: Clean refactored API gateway with minimal vertical slice
  version: 0.1.0
tags:
- name: Webhooks
paths:
  /api/v1/webhooks:
    get:
      tags:
      - Webhooks
      summary: List Webhooks
      description: List the workspace's webhook subscriptions.
      operationId: list_webhooks_api_v1_webhooks_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/WebhookResponse'
                type: array
                title: Response List Webhooks Api V1 Webhooks Get
    post:
      tags:
      - Webhooks
      summary: Create Webhook
      description: Subscribe a URL to webhook events. The signing secret is returned once, in this response only; see the Webhooks guide for verification.
      operationId: create_webhook_api_v1_webhooks_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWebhookRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateWebhookResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/webhooks/{webhook_id}:
    delete:
      tags:
      - Webhooks
      summary: Delete Webhook
      description: Delete a webhook subscription. Deliveries already queued are dropped.
      operationId: delete_webhook_api_v1_webhooks__webhook_id__delete
      parameters:
      - name: webhook_id
        in: path
        required: true
        schema:
          type: integer
          title: Webhook Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/webhooks/{webhook_id}/activate:
    patch:
      tags:
      - Webhooks
      summary: Activate Webhook
      description: Re-enable a subscription that was paused after repeated delivery failures.
      operationId: activate_webhook_api_v1_webhooks__webhook_id__activate_patch
      parameters:
      - name: webhook_id
        in: path
        required: true
        schema:
          type: integer
          title: Webhook Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/webhooks/{webhook_id}/deliveries:
    get:
      tags:
      - Webhooks
      summary: List Webhook Deliveries
      description: List recent delivery attempts for a subscription with status, response code and next retry time.
      operationId: list_webhook_deliveries_api_v1_webhooks__webhook_id__deliveries_get
      parameters:
      - name: webhook_id
        in: path
        required: true
        schema:
          type: integer
          title: Webhook Id
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 50
          title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DeliveryResponse'
                title: Response List Webhook Deliveries Api V1 Webhooks  Webhook Id  Deliveries Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /webhooks/{path}:
    get:
      summary: Proxy Webhooks
      description: 'Proxy webhook requests to channel-sync-service.


        This enables local development with Cloudflare tunnel where

        all external requests come to api-gateway but webhooks need

        to reach channel-sync-service.'
      operationId: proxy_webhooks_webhooks__path__get
      parameters:
      - name: path
        in: path
        required: true
        schema:
          type: string
          title: Path
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Webhooks
    delete:
      summary: Proxy Webhooks
      description: 'Proxy webhook requests to channel-sync-service.


        This enables local development with Cloudflare tunnel where

        all external requests come to api-gateway but webhooks need

        to reach channel-sync-service.'
      operationId: deleteWebhooksByPath
      parameters:
      - name: path
        in: path
        required: true
        schema:
          type: string
          title: Path
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Webhooks
      x-operation-id-source: normalized
      x-operation-id-original: proxy_webhooks_webhooks__path__get
    post:
      summary: Proxy Webhooks
      description: 'Proxy webhook requests to channel-sync-service.


        This enables local development with Cloudflare tunnel where

        all external requests come to api-gateway but webhooks need

        to reach channel-sync-service.'
      operationId: postWebhooksByPath
      parameters:
      - name: path
        in: path
        required: true
        schema:
          type: string
          title: Path
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Webhooks
      x-operation-id-source: normalized
      x-operation-id-original: proxy_webhooks_webhooks__path__get
    put:
      summary: Proxy Webhooks
      description: 'Proxy webhook requests to channel-sync-service.


        This enables local development with Cloudflare tunnel where

        all external requests come to api-gateway but webhooks need

        to reach channel-sync-service.'
      operationId: putWebhooksByPath
      parameters:
      - name: path
        in: path
        required: true
        schema:
          type: string
          title: Path
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Webhooks
      x-operation-id-source: normalized
      x-operation-id-original: proxy_webhooks_webhooks__path__get
components:
  schemas:
    CreateWebhookResponse:
      properties:
        id:
          type: integer
          title: Id
        url:
          type: string
          title: Url
        event_types:
          items:
            type: string
          type: array
          title: Event Types
        active:
          type: boolean
          title: Active
        created_at:
          type: string
          title: Created At
        agent_id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Agent Id
        secret:
          type: string
          title: Secret
      type: object
      required:
      - id
      - url
      - event_types
      - active
      - created_at
      - secret
      title: CreateWebhookResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    WebhookResponse:
      properties:
        id:
          type: integer
          title: Id
        url:
          type: string
          title: Url
        event_types:
          items:
            type: string
          type: array
          title: Event Types
        active:
          type: boolean
          title: Active
        created_at:
          type: string
          title: Created At
        agent_id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Agent Id
      type: object
      required:
      - id
      - url
      - event_types
      - active
      - created_at
      title: WebhookResponse
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    DeliveryResponse:
      properties:
        id:
          type: integer
          title: Id
        event_type:
          type: string
          title: Event Type
        status:
          type: string
          title: Status
        response_status:
          anyOf:
          - type: integer
          - type: 'null'
          title: Response Status
        attempt:
          type: integer
          title: Attempt
        max_attempts:
          type: integer
          title: Max Attempts
        created_at:
          type: string
          title: Created At
        delivered_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Delivered At
        next_attempt_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Attempt At
      type: object
      required:
      - id
      - event_type
      - status
      - response_status
      - attempt
      - max_attempts
      - created_at
      - delivered_at
      - next_attempt_at
      title: DeliveryResponse
    CreateWebhookRequest:
      properties:
        url:
          type: string
          title: Url
        event_types:
          items:
            type: string
            enum:
            - message.received
            - message.updated
            - message.deleted
            - conversation.started
            - conversation.updated
            - handoff.requested
            - draft.created
            - contact.updated
            - session.completed
            - call.started
            - call.ended
            - transcript.turn
            - transcript.ready
            - partner.signup.ready
            - partner.payment.succeeded
          type: array
          title: Event Types
        agent_id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Agent Id
      type: object
      required:
      - url
      - event_types
      title: CreateWebhookRequest