Airia

Airia Outbound Webhook Subscription API

The OutboundWebhookSubscription API from Airia — 4 operation(s) for outboundwebhooksubscription.

GitHub OpenAPI
Business capability
Webhook & Event Subscription Management BC-4270.80

Operations 7

GET /v1/OutboundWebhookSubscription Outbound webhook subscription get all #
POST /v1/OutboundWebhookSubscription Outbound webhook subscription create #
GET /v1/OutboundWebhookSubscription/{id} Outbound webhook subscription get by id #
PUT /v1/OutboundWebhookSubscription/{id} Outbound webhook subscription update #
DELETE /v1/OutboundWebhookSubscription/{id} Outbound webhook subscription delete #
POST /v1/OutboundWebhookSubscription/{id}/regenerate-secret Outbound webhook subscription regenerate secret #
GET /v1/OutboundWebhookSubscription/{id}/delivery-log Outbound webhook subscription get delivery log #

Documentation

📖
APIReference
https://api.airia.ai/docs/
📖
Documentation
https://airia.ai/docs/build/interface-options/api-deployment
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/airia/refs/heads/main/authentication/airia-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/airia/refs/heads/main/openapi/airia-outboundwebhooksubscription-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/airia/refs/heads/main/errors/airia-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/airia/refs/heads/main/conventions/airia-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/airia/refs/heads/main/data-model/airia-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/airia/refs/heads/main/asyncapi/airia-webhooks.yml

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/airia:airia-outboundwebhooksubscription-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

airia-outboundwebhooksubscription-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Airia Web Outbound Webhook Subscription API
  version: 1.0.0
servers:
- url: https://api.airia.ai
tags:
- name: OutboundWebhookSubscription
paths:
  /v1/OutboundWebhookSubscription:
    get:
      tags:
      - OutboundWebhookSubscription
      operationId: OutboundWebhookSubscription_GetAll
      parameters:
      - name: x-correlation-id
        in: header
        schema:
          type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OutboundWebhookSubscriptionDto'
        401:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        403:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Outbound webhook subscription get all
      x-summary-source: derived
    post:
      tags:
      - OutboundWebhookSubscription
      operationId: OutboundWebhookSubscription_Create
      parameters:
      - name: x-correlation-id
        in: header
        schema:
          type: string
      requestBody:
        x-name: dto
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OutboundWebhookSubscriptionDto'
        required: true
        x-position: 1
      responses:
        201:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutboundWebhookSubscriptionDto'
        400:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        401:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        403:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Outbound webhook subscription create
      x-summary-source: derived
  /v1/OutboundWebhookSubscription/{id}:
    get:
      tags:
      - OutboundWebhookSubscription
      operationId: OutboundWebhookSubscription_GetById
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 1
      - name: x-correlation-id
        in: header
        schema:
          type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutboundWebhookSubscriptionDto'
        401:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        403:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        404:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Outbound webhook subscription get by id
      x-summary-source: derived
    put:
      tags:
      - OutboundWebhookSubscription
      operationId: OutboundWebhookSubscription_Update
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 1
      - name: x-correlation-id
        in: header
        schema:
          type: string
      requestBody:
        x-name: dto
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OutboundWebhookSubscriptionDto'
        required: true
        x-position: 2
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutboundWebhookSubscriptionDto'
        400:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        401:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        403:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        404:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Outbound webhook subscription update
      x-summary-source: derived
    delete:
      tags:
      - OutboundWebhookSubscription
      operationId: OutboundWebhookSubscription_Delete
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 1
      - name: x-correlation-id
        in: header
        schema:
          type: string
      responses:
        204:
          description: ''
        401:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        403:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        404:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Outbound webhook subscription delete
      x-summary-source: derived
  /v1/OutboundWebhookSubscription/{id}/regenerate-secret:
    post:
      tags:
      - OutboundWebhookSubscription
      operationId: OutboundWebhookSubscription_RegenerateSecret
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 1
      - name: x-correlation-id
        in: header
        schema:
          type: string
      responses:
        200:
          description: ''
        400:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        401:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        403:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        404:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Outbound webhook subscription regenerate secret
      x-summary-source: derived
  /v1/OutboundWebhookSubscription/{id}/delivery-log:
    get:
      tags:
      - OutboundWebhookSubscription
      operationId: OutboundWebhookSubscription_GetDeliveryLog
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 1
      - name: limit
        in: query
        schema:
          type: integer
          format: int32
          default: 50
        x-position: 2
      - name: x-correlation-id
        in: header
        schema:
          type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OutboundWebhookDeliveryLogDto'
        401:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        403:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Outbound webhook subscription get delivery log
      x-summary-source: derived
components:
  schemas:
    ProblemDetails:
      type: object
      additionalProperties: {}
      properties:
        type:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
        status:
          type:
          - integer
          - 'null'
          format: int32
        detail:
          type:
          - string
          - 'null'
        instance:
          type:
          - string
          - 'null'
    OutboundWebhookSubscriptionDto:
      type: object
      additionalProperties: false
      properties:
        id:
          type:
          - string
          - 'null'
          format: guid
        name:
          type: string
        description:
          type:
          - string
          - 'null'
        url:
          type: string
        authMethod:
          type:
          - string
          - 'null'
        bearerToken:
          type:
          - string
          - 'null'
        eventTypes:
          type: array
          items:
            type: string
        enabled:
          type:
          - boolean
          - 'null'
        signingSecret:
          type:
          - string
          - 'null'
        consecutiveFailures:
          type: integer
          format: int32
        lastDeliveryAt:
          type:
          - string
          - 'null'
          format: date-time
        disabledReason:
          type:
          - string
          - 'null'
        createdAt:
          type:
          - string
          - 'null'
          format: date-time
    OutboundWebhookDeliveryLogDto:
      type: object
      additionalProperties: false
      properties:
        id:
          type: string
          format: guid
        eventId:
          type: string
          format: guid
        eventType:
          type: string
        attemptNumber:
          type: integer
          format: int32
        status:
          type: string
        httpStatusCode:
          type:
          - integer
          - 'null'
          format: int32
        latencyMs:
          type:
          - integer
          - 'null'
          format: int64
        errorMessage:
          type:
          - string
          - 'null'
        attemptedAt:
          type: string
          format: date-time
  securitySchemes:
    ApiKey:
      type: apiKey
      description: API Key Authentication
      name: X-API-Key
      in: header
    Cookies:
      type: apiKey
      description: Cookie based Authentication
      name: Cookie
      in: header
x-generator: NSwag v14.7.1.0 (NJsonSchema v11.6.1.0 (Newtonsoft.Json v13.0.0.0))