Componecat Outgoing Webhooks API

The Outgoing Webhooks API from Componecat — 4 operation(s) for outgoing webhooks.

Documentation GitHub OpenAPI

Operations 6

GET /api/rest/v1/outgoing-webhooks List outgoing webhooks in the current organization #

POST /api/rest/v1/outgoing-webhooks Create an outgoing webhook (returns the signing secret once) #

GET /api/rest/v1/outgoing-webhooks/event-metadata List the entity types, actions, and custom filters a webhook can filter on #

PATCH /api/rest/v1/outgoing-webhooks/{id} Update an outgoing webhook #

DELETE /api/rest/v1/outgoing-webhooks/{id} Delete an outgoing webhook #

POST /api/rest/v1/outgoing-webhooks/{id}/rotate-secret Rotate an outgoing webhook's signing secret #

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/componecat-ai:componecat-ai-outgoing-webhooks-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

openapi: 3.2.0
info:
  title: Componecat Ai Outgoing Webhooks API
  version: v1
  description: 'Operations tagged Outgoing Webhooks across 2 of this provider''s published API definitions: componecat-ai-openapi.json, componecat-ai-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://app.componecat.ai/
security:
- {}
tags:
- name: Outgoing Webhooks
paths:
  /api/rest/v1/outgoing-webhooks:
    get:
      tags:
      - Outgoing Webhooks
      summary: List outgoing webhooks in the current organization
      operationId: ListOutgoingWebhooks
      parameters:
      - name: skip
        in: query
        schema:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
          - integer
          - string
          format: int32
      - name: take
        in: query
        schema:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
          - integer
          - string
          format: int32
      responses:
        '200':
          description: OK
    post:
      tags:
      - Outgoing Webhooks
      summary: Create an outgoing webhook (returns the signing secret once)
      operationId: CreateOutgoingWebhook
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOutgoingWebhookRequest'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedOutgoingWebhookResource'
    servers:
    - url: https://app.componecat.ai/
  /api/rest/v1/outgoing-webhooks/event-metadata:
    get:
      tags:
      - Outgoing Webhooks
      summary: List the entity types, actions, and custom filters a webhook can filter on
      operationId: GetOutgoingWebhookEventMetadata
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutgoingWebhookEventMetadataResource'
    servers:
    - url: https://app.componecat.ai/
  /api/rest/v1/outgoing-webhooks/{id}:
    patch:
      tags:
      - Outgoing Webhooks
      summary: Update an outgoing webhook
      operationId: UpdateOutgoingWebhook
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonElement'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutgoingWebhookResource'
    delete:
      tags:
      - Outgoing Webhooks
      summary: Delete an outgoing webhook
      operationId: DeleteOutgoingWebhook
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: No Content
        '404':
          description: Not Found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    servers:
    - url: https://app.componecat.ai/
  /api/rest/v1/outgoing-webhooks/{id}/rotate-secret:
    post:
      tags:
      - Outgoing Webhooks
      summary: Rotate an outgoing webhook's signing secret
      operationId: RotateOutgoingWebhookSecret
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RotatedSecretResource'
    servers:
    - url: https://app.componecat.ai/
components:
  schemas:
    OutgoingWebhookCustomFilterOptionResource:
      required:
      - value
      - label
      type: object
      properties:
        value:
          type: string
        label:
          type: string
    OutgoingWebhookResource:
      required:
      - id
      - url
      - description
      - entityTypeFilters
      - eventFilters
      - customFilters
      - customHeaderNames
      - detailLevel
      - status
      - consecutiveFailures
      - lastDeliveryAt
      - createdAt
      - updatedAt
      type: object
      properties:
        id:
          type: string
          format: uuid
        url:
          type: string
        description:
          type:
          - 'null'
          - string
        entityTypeFilters:
          type:
          - 'null'
          - array
          items:
            type: string
        eventFilters:
          type:
          - 'null'
          - array
          items:
            type: string
        customFilters:
          type:
          - 'null'
          - array
          items:
            $ref: '#/components/schemas/OutgoingWebhookCustomFilterSelectionResource'
        customHeaderNames:
          type: array
          items:
            type: string
        detailLevel:
          type: string
        status:
          type: string
        consecutiveFailures:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
          - integer
          - string
          format: int32
        lastDeliveryAt:
          type:
          - 'null'
          - string
          format: date-time
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    ProblemDetails:
      type: object
      properties:
        type:
          type:
          - 'null'
          - string
        title:
          type:
          - 'null'
          - string
        status:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
          - 'null'
          - integer
          - string
          format: int32
        detail:
          type:
          - 'null'
          - string
        instance:
          type:
          - 'null'
          - string
    RotatedSecretResource:
      required:
      - webhookId
      - newSecret
      - rotatedAt
      type: object
      properties:
        webhookId:
          type: string
          format: uuid
        newSecret:
          type: string
        rotatedAt:
          type: string
          format: date-time
    OutgoingWebhookEntityTypeMetadataResource:
      required:
      - name
      - label
      - wireName
      - actions
      type: object
      properties:
        name:
          type: string
        label:
          type: string
        wireName:
          type: string
        actions:
          type: array
          items:
            $ref: '#/components/schemas/OutgoingWebhookEntityActionMetadataResource'
    OutgoingWebhookCustomFilterMetadataResource:
      required:
      - key
      - label
      - description
      - appliesToEntityTypes
      - options
      type: object
      properties:
        key:
          type: string
        label:
          type: string
        description:
          type:
          - 'null'
          - string
        appliesToEntityTypes:
          type: array
          items:
            type: string
        options:
          type: array
          items:
            $ref: '#/components/schemas/OutgoingWebhookCustomFilterOptionResource'
    JsonElement: {}
    OutgoingWebhookEventMetadataResource:
      required:
      - entityTypes
      - actions
      - customFilters
      type: object
      properties:
        entityTypes:
          type: array
          items:
            $ref: '#/components/schemas/OutgoingWebhookEntityTypeMetadataResource'
        actions:
          type: array
          items:
            $ref: '#/components/schemas/OutgoingWebhookActionMetadataResource'
        customFilters:
          type: array
          items:
            $ref: '#/components/schemas/OutgoingWebhookCustomFilterMetadataResource'
    OutgoingWebhookActionMetadataResource:
      required:
      - name
      - label
      type: object
      properties:
        name:
          type: string
        label:
          type: string
    OutgoingWebhookCustomHeaderResource:
      required:
      - name
      - value
      type: object
      properties:
        name:
          type: string
        value:
          type:
          - 'null'
          - string
    CreatedOutgoingWebhookResource:
      required:
      - id
      - url
      - description
      - status
      - secret
      - createdAt
      type: object
      properties:
        id:
          type: string
          format: uuid
        url:
          type: string
        description:
          type:
          - 'null'
          - string
        status:
          type: string
        secret:
          type: string
        createdAt:
          type: string
          format: date-time
    OutgoingWebhookCustomFilterSelectionResource:
      required:
      - key
      - values
      type: object
      properties:
        key:
          type: string
        values:
          type: array
          items:
            type: string
    CreateOutgoingWebhookRequest:
      required:
      - url
      - description
      - eventFilters
      - detailLevel
      type: object
      properties:
        url:
          type: string
        description:
          type:
          - 'null'
          - string
        eventFilters:
          type:
          - 'null'
          - array
          items:
            type: string
        detailLevel:
          type:
          - 'null'
          - string
        entityTypeFilters:
          type:
          - 'null'
          - array
          items:
            type: string
        customFilters:
          type:
          - 'null'
          - array
          items:
            $ref: '#/components/schemas/OutgoingWebhookCustomFilterSelectionResource'
        customHeaders:
          type:
          - 'null'
          - array
          items:
            $ref: '#/components/schemas/OutgoingWebhookCustomHeaderResource'
    OutgoingWebhookEntityActionMetadataResource:
      required:
      - name
      - label
      - eventType
      type: object
      properties:
        name:
          type: string
        label:
          type: string
        eventType:
          type: string
  securitySchemes:
    bearer:
      type: http
      description: Personal access token. Create one in the application settings.
      scheme: bearer
      bearerFormat: JWT
x-refined-from:
- componecat-ai-openapi.json
- componecat-ai-openapi.yml