Configure Webhooks API

The Webhooks API from Configure — 3 operation(s) for webhooks.

GitHub OpenAPI

Operations 5

PUT /v1/webhooks Register or update the profile webhook #
GET /v1/webhooks Get the profile webhook and its delivery counts #
DELETE /v1/webhooks Delete the profile webhook #
GET /v1/webhooks/secret Read the profile webhook signing secret #
POST /v1/webhooks/test Send a signed ping to the profile webhook #

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/configure-dev:configure-dev-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.

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

OpenAPI Specification

configure-dev-webhooks-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Configure Dev Webhooks API
  version: 2026-07-12
  description: 'Operations tagged Webhooks across 2 of this provider''s published API definitions: configure-dev-openapi-original.yaml, configure-dev-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.configure.dev
  description: Production
- url: https://configure-backend-staging.fly.dev
  description: Staging
security:
- ApiKeyAuth: []
tags:
- name: Webhooks
paths:
  /v1/webhooks:
    put:
      tags:
      - Webhooks
      summary: Register or update the profile webhook
      description: One endpoint per agent and plane. The secret is returned only when this call mints it (create or rotate_secret). Events are signed per Standard Webhooks.
      security:
      - SecretApiKeyAuth: []
      parameters:
      - $ref: '#/components/parameters/AgentHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              required:
              - url
              properties:
                url:
                  type: string
                  format: uri
                rotate_secret:
                  type: boolean
      responses:
        '201':
          description: Endpoint created; the response carries `secret`.
        '200':
          description: Endpoint updated.
        '400':
          $ref: '#/components/responses/InvalidFormat'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
      operationId: putV1Webhooks
      x-operation-id-source: derived
    get:
      tags:
      - Webhooks
      summary: Get the profile webhook and its delivery counts
      security:
      - SecretApiKeyAuth: []
      parameters:
      - $ref: '#/components/parameters/AgentHeader'
      responses:
        '200':
          description: The endpoint, without its secret.
        '404':
          description: No endpoint registered.
      operationId: getV1Webhooks
      x-operation-id-source: derived
    delete:
      tags:
      - Webhooks
      summary: Delete the profile webhook
      security:
      - SecretApiKeyAuth: []
      parameters:
      - $ref: '#/components/parameters/AgentHeader'
      responses:
        '200':
          description: Deleted.
        '404':
          description: No endpoint registered.
      operationId: deleteV1Webhooks
      x-operation-id-source: derived
    servers:
    - url: https://api.configure.dev
      description: Production
    - url: https://configure-backend-staging.fly.dev
      description: Staging
  /v1/webhooks/secret:
    get:
      tags:
      - Webhooks
      summary: Read the profile webhook signing secret
      security:
      - SecretApiKeyAuth: []
      parameters:
      - $ref: '#/components/parameters/AgentHeader'
      responses:
        '200':
          description: '`secret`, plus `previous_secret` for 24 hours after a rotation.'
        '404':
          description: No endpoint registered.
      operationId: getV1WebhooksSecret
      x-operation-id-source: derived
    servers:
    - url: https://api.configure.dev
      description: Production
    - url: https://configure-backend-staging.fly.dev
      description: Staging
  /v1/webhooks/test:
    post:
      tags:
      - Webhooks
      summary: Send a signed ping to the profile webhook
      security:
      - SecretApiKeyAuth: []
      parameters:
      - $ref: '#/components/parameters/AgentHeader'
      responses:
        '200':
          description: '`delivered`, the endpoint''s `status`, and `ms`.'
        '404':
          description: No endpoint registered.
      operationId: postV1WebhooksTest
      x-operation-id-source: derived
    servers:
    - url: https://api.configure.dev
      description: Production
    - url: https://configure-backend-staging.fly.dev
      description: Staging
components:
  parameters:
    AgentHeader:
      name: X-Agent
      in: header
      required: false
      schema:
        $ref: '#/components/schemas/AgentName'
      description: Required when the API key's developer account owns more than one active agent.
  schemas:
    ErrorEnvelope:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
            code:
              type: string
            message:
              type: string
            param:
              type:
              - string
              - 'null'
            retryable:
              type: boolean
        request_id:
          type: string
    AgentName:
      type: string
      minLength: 2
      maxLength: 63
      pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$
      example: your-agent
  responses:
    RateLimited:
      description: Rate or concurrency limit exceeded.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    InvalidFormat:
      description: Request shape is invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Forbidden:
      description: Forbidden. Common causes include secret_key_required, token_wrong_type, approval_required, or access_denied.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Configure API key. Use sk_ on servers. pk_ is browser-safe but restricted.
    SecretApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Server-side Configure secret key, prefix sk_.
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Agent-scoped Configure token from hosted Configure.link().
    ExternalUserId:
      type: apiKey
      in: header
      name: X-User-Id
      description: Stable external user ID for unlinked developer-scoped profiles. Requires sk_.
x-refined-from:
- configure-dev-openapi-original.yaml
- configure-dev-openapi.yml