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/bellatorsi-com:bellatorsi-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

openapi: 3.2.0
info:
  title: Bellatorsi Com Webhooks API
  version: '1.0'
  description: 'Operations tagged webhooks across 2 of this provider''s published API definitions: api-bellatorsi-com-openapi.json, bellatorsi-com-openapi.json. Each path carries the servers of the definition it was published in.'
tags:
- name: Webhooks
paths:
  /api/v1/webhooks/register:
    post:
      tags:
      - Webhooks
      summary: Register Webhook
      description: 'Register webhook callback URL for async job notifications.


        **Webhook Events:**

        - `job.completed` - Job finished successfully

        - `job.failed` - Job encountered error

        - `job.cancelled` - Job was cancelled


        **Webhook Payload:**

        ```json

        {

        "event": "job.completed",

        "job_id": "550e8400-e29b-41d4-a716-446655440000",

        "timestamp": "2025-01-08T12:00:25Z",

        "data": {

        "job_id": "550e8400-e29b-41d4-a716-446655440000",

        "status": "completed",

        "result": {...}

        }

        }

        ```


        **Signature Verification:**

        - HMAC-SHA256 signature in `X-Bellator-Signature` header

        - Format: `sha256=`

        - Payload: JSON-serialized webhook payload (deterministic order)


        **Delivery Guarantees:**

        - At-least-once delivery

        - Max 3 retry attempts with exponential backoff

        - 5 second initial retry delay, 15 second max delay

        - Target delivery: <5 seconds after job completion


        **Best Practices:**

        - Return 2xx status code quickly (<1 second)

        - Process webhook payload asynchronously

        - Verify signature if secret provided

        - Implement idempotency using job_id'
      operationId: register_webhook_api_v1_webhooks_register_post
      parameters:
      - name: x-api-key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: x-bellator-internal-dispatch
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Bellator-Internal-Dispatch
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookRegistration'
      responses:
        '200':
          description: Success - Webhook registered
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  anyOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                title: Response Register Webhook Api V1 Webhooks Register Post
              example:
                status: registered
                webhook_id: wh_abc123
                url: https://customer.example.com/webhooks/bellator
                events:
                - job.completed
                - job.failed
                message: Webhook registered successfully. Will be used for all async jobs.
        '400':
          description: Bad Request - Invalid webhook configuration
          content:
            application/json:
              example:
                detail: Invalid URL format or event types
        '429':
          description: Too Many Requests - Rate limit exceeded
          content:
            application/json:
              example:
                detail: Rate limit exceeded. Maximum 500 requests per 60 seconds.
                type: rate_limit_exceeded
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/webhooks/registration:
    get:
      tags:
      - Webhooks
      summary: Get Webhook Registration
      description: 'Get the current webhook registration for the authenticated tenant.


        Returns the registered webhook URL, events, and metadata.'
      operationId: get_webhook_registration_api_v1_webhooks_registration_get
      parameters:
      - name: x-api-key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: x-bellator-internal-dispatch
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Bellator-Internal-Dispatch
      responses:
        '200':
          description: Success - Webhook registration found
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Webhook Registration Api V1 Webhooks Registration Get
              example:
                webhook_id: wh_abc123
                url: https://customer.example.com/webhooks/bellator
                events:
                - job.completed
                - job.failed
                created_at: '2025-01-08T12:00:00Z'
        '404':
          description: Not Found - No webhook registration found
          content:
            application/json:
              example:
                detail: No webhook registration found for this tenant
        '429':
          description: Too Many Requests - Rate limit exceeded
          content:
            application/json:
              example:
                detail: Rate limit exceeded. Maximum 500 requests per 60 seconds.
                type: rate_limit_exceeded
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Webhooks
      summary: Delete Webhook Registration
      description: 'Delete the webhook registration for the authenticated tenant.


        After deletion, no webhooks will be sent for future async jobs.'
      operationId: delete_webhook_registration_api_v1_webhooks_registration_delete
      parameters:
      - name: x-api-key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: x-bellator-internal-dispatch
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Bellator-Internal-Dispatch
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
                title: Response Delete Webhook Registration Api V1 Webhooks Registration Delete
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/webhooks/deliveries/{webhook_id}:
    get:
      tags:
      - Webhooks
      summary: Get Delivery Status
      description: 'Get delivery status for a specific webhook delivery attempt.


        Returns delivery metadata including attempts, success status, and errors.'
      operationId: get_delivery_status_api_v1_webhooks_deliveries__webhook_id__get
      parameters:
      - name: webhook_id
        in: path
        required: true
        schema:
          type: string
          title: Webhook Id
      - name: x-api-key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: x-bellator-internal-dispatch
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Bellator-Internal-Dispatch
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Delivery Status Api V1 Webhooks Deliveries  Webhook Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/webhooks/deliveries/job/{job_id}:
    get:
      tags:
      - Webhooks
      summary: Get Job Deliveries
      description: 'Get all webhook delivery attempts for a specific job.


        Returns a list of all delivery attempts made for this job,

        including successes and failures.'
      operationId: get_job_deliveries_api_v1_webhooks_deliveries_job__job_id__get
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      - name: x-api-key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: x-bellator-internal-dispatch
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Bellator-Internal-Dispatch
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  additionalProperties: true
                title: Response Get Job Deliveries Api V1 Webhooks Deliveries Job  Job Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/webhooks/dlq:
    get:
      tags:
      - Webhooks
      summary: Get Dead Letter Queue
      description: 'Get entries from the webhook dead letter queue (DLQ).


        The DLQ contains webhooks that permanently failed after all retry attempts.

        Use for monitoring and debugging webhook delivery issues.


        **Query Parameters:**

        - `limit`: Maximum number of entries to return (default: 100, max: 1000)

        - `offset`: Number of entries to skip for pagination (default: 0)'
      operationId: get_dlq_api_v1_webhooks_dlq_get
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 100
          title: Limit
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          default: 0
          title: Offset
      - name: x-api-key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: x-bellator-internal-dispatch
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Bellator-Internal-Dispatch
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Dlq Api V1 Webhooks Dlq Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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
    WebhookRegistration:
      properties:
        url:
          type: string
          maxLength: 2083
          minLength: 1
          format: uri
          title: Url
          description: Webhook callback URL
        events:
          items:
            type: string
          type: array
          title: Events
          description: Events to trigger webhook
        secret:
          anyOf:
          - type: string
          - type: 'null'
          title: Secret
          description: Shared secret for webhook signature validation
      type: object
      required:
      - url
      title: WebhookRegistration
      description: Model for webhook callback registration.
      example:
        events:
        - job.completed
        - job.failed
        secret: whsec_abc123
        url: https://customer.example.com/webhooks/bellator
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key for authentication. Required when API_KEY is configured.
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://login.microsoftonline.com/{tenant}/oauth2/v2.0/authorize
          tokenUrl: https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token
          scopes:
            api.read: Read access to API
            api.write: Write access to API
      description: OAuth 2.0 / Azure AD authentication (recommended)
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT Bearer token from OAuth 2.0 / Azure AD
x-refined-from:
- api-bellatorsi-com-openapi.json
- bellatorsi-com-openapi.json