ASAP

ASAP Webhooks API

Outbound signed webhook endpoints (subscriptions) for org events.

GitHub OpenAPI

Operations 7

GET /v1/webhooks/endpoints List webhook endpoints, newest first #
POST /v1/webhooks/endpoints Create a webhook endpoint and return its cleartext secret once #
GET /v1/webhooks/endpoints/{id} Fetch a webhook endpoint by id #
DELETE /v1/webhooks/endpoints/{id} Delete a webhook endpoint by id #
PATCH /v1/webhooks/endpoints/{id} Enable or disable a webhook endpoint #
GET /v1/webhooks/endpoints/{id}/deliveries List the most recent deliveries of an endpoint, newest first #
GET /v1/webhooks/events List the event types an endpoint can subscribe to #

Documentation

📖
Documentation
https://docs.asap.cool/reference/
📖
APIReference
https://docs.asap.cool/reference/

Specifications

⚙
OpenAPI
https://artifacts.apis.io/asap-cool/openapi/asap-cool-webhooks-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/asap-cool/json-schema/asap-cool-document-view-schema.json
📊
JSONSchema
https://artifacts.apis.io/asap-cool/json-schema/asap-cool-company-profile-view-schema.json
📊
JSONSchema
https://artifacts.apis.io/asap-cool/json-schema/asap-cool-update-company-profile-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/asap-cool/json-schema/asap-cool-contact-view-schema.json
📊
JSONSchema
https://artifacts.apis.io/asap-cool/json-schema/asap-cool-envelope-view-schema.json
📊
JSONSchema
https://artifacts.apis.io/asap-cool/json-schema/asap-cool-inbound-view-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/asap-cool:asap-cool-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

asap-cool-webhooks-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: ASAP Platform Webhooks API
  description: 'Public HTTP API for ASAP Platform (api.asap.cool).


    All `/v1` responses are wrapped in a standard envelope. Success responses are `{ "data": , "meta": { "request_id", "next_cursor"?, "has_more"? } }` — the schema documented for each operation describes the inner `data` value. Errors are `{ "error": { "code", "message", "field"?, "request_id" } }`. Every response also carries an `X-Request-Id` header matching `meta.request_id` / `error.request_id`.'
  license:
    name: BUSL-1.1
  version: 0.0.0
servers:
- url: https://api.asap.cool
  description: Production
tags:
- name: Webhooks
  description: Outbound signed webhook endpoints (subscriptions) for org events.
paths:
  /v1/webhooks/endpoints:
    get:
      tags:
      - Webhooks
      summary: List webhook endpoints, newest first
      operationId: listWebhookEndpoints
      responses:
        '200':
          description: Webhook endpoints.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WebhookEndpointView'
        '401':
          description: No active org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Missing webhooks:read scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - api_key:
        - webhooks:read
      - session: []
    post:
      tags:
      - Webhooks
      summary: Create a webhook endpoint and return its cleartext secret once
      operationId: createWebhookEndpoint
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWebhookEndpointRequest'
        required: true
      responses:
        '201':
          description: Endpoint created; secret returned once.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookEndpointCreated'
        '401':
          description: No active org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Missing webhooks:write scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '422':
          description: Invalid endpoint payload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - api_key:
        - webhooks:write
      - session: []
  /v1/webhooks/endpoints/{id}:
    get:
      tags:
      - Webhooks
      summary: Fetch a webhook endpoint by id
      operationId: getWebhookEndpoint
      parameters:
      - name: id
        in: path
        description: Endpoint identifier.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: The webhook endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookEndpointView'
        '401':
          description: No active org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Missing webhooks:read scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: Not found or cross-org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - api_key:
        - webhooks:read
      - session: []
    delete:
      tags:
      - Webhooks
      summary: Delete a webhook endpoint by id
      operationId: deleteWebhookEndpoint
      parameters:
      - name: id
        in: path
        description: Endpoint identifier.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Endpoint deleted.
        '401':
          description: No active org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Missing webhooks:write scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: Not found or cross-org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - api_key:
        - webhooks:write
      - session: []
    patch:
      tags:
      - Webhooks
      summary: Enable or disable a webhook endpoint
      operationId: updateWebhookEndpoint
      parameters:
      - name: id
        in: path
        description: Endpoint identifier.
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWebhookEndpointRequest'
        required: true
      responses:
        '200':
          description: The updated endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookEndpointView'
        '401':
          description: No active org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Missing webhooks:write scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: Not found or cross-org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - api_key:
        - webhooks:write
      - session: []
  /v1/webhooks/endpoints/{id}/deliveries:
    get:
      tags:
      - Webhooks
      summary: List the most recent deliveries of an endpoint, newest first
      operationId: listWebhookDeliveries
      parameters:
      - name: id
        in: path
        description: Endpoint identifier.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Recent deliveries (max 50).
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WebhookDeliveryView'
        '401':
          description: No active org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Missing webhooks:read scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: Endpoint not found or cross-org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - api_key:
        - webhooks:read
      - session: []
  /v1/webhooks/events:
    get:
      tags:
      - Webhooks
      summary: List the event types an endpoint can subscribe to
      operationId: listWebhookEvents
      responses:
        '200':
          description: Subscribable event types.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookEventsView'
        '403':
          description: Missing webhooks:read scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - api_key:
        - webhooks:read
      - session: []
components:
  schemas:
    CreateWebhookEndpointRequest:
      type: object
      description: Create-endpoint request body.
      required:
      - url
      - events
      properties:
        enabled:
          type: boolean
          description: Whether the endpoint starts enabled (defaults to `true`).
        events:
          type: array
          items:
            type: string
          description: Event tokens to subscribe to (non-empty, all documented events).
        url:
          type: string
          description: Absolute `https://` URL deliveries are `POSTed` to.
    UpdateWebhookEndpointRequest:
      type: object
      description: Update-endpoint request body.
      required:
      - enabled
      properties:
        enabled:
          type: boolean
          description: Enable or disable deliveries to this endpoint.
    WebhookEndpointCreated:
      type: object
      description: 'Creation response: the endpoint plus its cleartext secret, returned once.'
      required:
      - id
      - url
      - events
      - enabled
      - created_at
      - secret
      properties:
        created_at:
          type: string
          description: Creation timestamp (RFC 3339).
        enabled:
          type: boolean
          description: Whether the endpoint is active.
        events:
          type: array
          items:
            type: string
          description: Subscribed event tokens.
        id:
          type: string
          format: uuid
          description: Stable identifier.
        secret:
          type: string
          description: Cleartext signing secret (`whsec_…`). Shown only here, never again.
        url:
          type: string
          description: Destination URL.
    WebhookEventsView:
      type: object
      description: Documented event types.
      required:
      - events
      properties:
        events:
          type: array
          items:
            type: string
          description: Dotted event tokens (`signature.envelope.completed`, …).
    ErrorBody:
      type: object
      description: 'Generic error body returned by API handlers when they fail. `code` is a

        stable machine-readable token; `message` is human-friendly and meant for

        surfacing to end users.'
      required:
      - code
      - message
      properties:
        code:
          type: string
          description: Stable machine token (e.g. `invalid_credentials`).
        field:
          type:
          - string
          - 'null'
          description: Offending request field for validation errors, when known.
        message:
          type: string
          description: Human-readable message.
    WebhookDeliveryView:
      type: object
      description: Public projection of a delivery.
      required:
      - id
      - event_id
      - event_type
      - status
      - attempts
      - payload
      - created_at
      properties:
        attempts:
          type: integer
          format: int32
          description: POST attempts made so far.
        created_at:
          type: string
          description: Creation timestamp (RFC 3339).
        event_id:
          type: string
          format: uuid
          description: Stable event id (the delivered envelope `id`).
        event_type:
          type: string
          description: Event type token.
        id:
          type: string
          format: uuid
          description: Delivery identifier.
        last_error:
          type:
          - string
          - 'null'
          description: Last transport or HTTP status error, if any.
        next_attempt_at:
          type:
          - string
          - 'null'
          description: Next retry due time (RFC 3339), absent once terminal.
        payload:
          description: JSON body that was (or will be) sent.
        status:
          type: string
          description: '`pending`, `succeeded` or `failed`.'
    WebhookEndpointView:
      type: object
      description: Public projection of a [`WebhookEndpoint`] (never exposes the secret).
      required:
      - id
      - url
      - events
      - enabled
      - created_at
      properties:
        created_at:
          type: string
          description: Creation timestamp (RFC 3339).
        enabled:
          type: boolean
          description: Whether the endpoint is active.
        events:
          type: array
          items:
            type: string
          description: Subscribed event tokens.
        id:
          type: string
          format: uuid
          description: Stable identifier.
        url:
          type: string
          description: Destination URL deliveries are `POSTed` to.
  securitySchemes:
    api_key:
      type: http
      scheme: bearer
    session:
      type: apiKey
      in: cookie
      name: asap_session