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/zvid-io:zvid-io-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: Zvid Io Webhooks API
  version: 1.1.0
  contact:
    name: Zvid Support
    url: https://zvid.io/contact
  description: 'Operations tagged Webhooks across 2 of this provider''s published API definitions: openapi.yaml, zvid-io-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.zvid.io
  description: Production server
security:
- ApiKeyAuth: []
tags:
- name: Webhooks
  description: HMAC-signed render event deliveries
paths:
  /api/webhooks:
    get:
      tags:
      - Webhooks
      summary: List webhooks
      operationId: listWebhooks
      responses:
        '200':
          description: Account endpoints and plan allowance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookList'
              examples:
                verifiedResponse:
                  summary: Representative successful response
                  description: Illustrative values verified against the operation contract; identifiers and URLs are examples.
                  value:
                    webhooks: []
                    usage:
                      used: 0
                      limit: 1
                      planName: Free
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
    post:
      tags:
      - Webhooks
      summary: Create webhook
      description: Register an account endpoint. Registered deliveries are signed with HMAC-SHA256(secret, timestamp + "." + raw body). There are at most 5 total attempts (initial plus retries after 30, 60, 120 and 240 seconds), a 10-second HTTP timeout, and no redirect following. Endpoints are disabled after 20 consecutive exhausted deliveries. Creation and GET by ID return the signing secret.
      operationId: createWebhook
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookRequest'
            examples:
              endpoint:
                summary: endpoint
                value:
                  url: https://example.com/hooks/zvid
                  events:
                  - render.completed
                  - render.failed
      responses:
        '201':
          description: Webhook created (includes secret)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Webhook'
              examples:
                verifiedResponse:
                  summary: Representative successful response
                  description: Illustrative values verified against the operation contract; identifiers and URLs are examples.
                  value:
                    id: whk_abcdefghijklmnopqrst
                    url: https://example.com/hooks/zvid
                    events:
                    - render.completed
                    status: active
                    secret: whsec_example_not_a_real_secret
                    created: true
        '400':
          description: Invalid URL (the hosted API requires a public HTTPS address and rejects private hosts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
    servers:
    - url: https://api.zvid.io
      description: Production server
  /api/webhooks/{id}:
    get:
      tags:
      - Webhooks
      summary: Get webhook
      operationId: getWebhook
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Endpoint including signing secret
          content:
            application/json:
              schema:
                type: object
                properties:
                  webhook:
                    $ref: '#/components/schemas/Webhook'
                required:
                - webhook
                additionalProperties: true
              examples:
                verifiedResponse:
                  summary: Representative successful response
                  description: Illustrative values verified against the operation contract; identifiers and URLs are examples.
                  value:
                    webhook:
                      id: whk_abcdefghijklmnopqrst
                      url: https://example.com/hooks/zvid
                      events:
                      - render.completed
                      status: active
                      secret: whsec_example_not_a_real_secret
        '404':
          description: Not found
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
    put:
      tags:
      - Webhooks
      summary: Update webhook
      operationId: updateWebhook
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookUpdate'
            examples:
              disable:
                summary: disable
                value:
                  status: disabled
      responses:
        '200':
          description: Updated webhook
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Webhook'
              examples:
                verifiedResponse:
                  summary: Representative successful response
                  description: Illustrative values verified against the operation contract; identifiers and URLs are examples.
                  value:
                    id: whk_abcdefghijklmnopqrst
                    url: https://example.com/hooks/zvid
                    events:
                    - render.completed
                    status: disabled
        '404':
          description: Not found
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
    delete:
      tags:
      - Webhooks
      summary: Delete webhook
      operationId: deleteWebhook
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Endpoint deleted
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleted:
                    type: boolean
                required:
                - deleted
                additionalProperties: true
              example:
                deleted: true
              examples:
                verifiedResponse:
                  summary: Representative successful response
                  description: Illustrative values verified against the operation contract; identifiers and URLs are examples.
                  value:
                    deleted: true
        '400':
          description: Invalid input or semantic validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '404':
          description: Not found for this account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
    servers:
    - url: https://api.zvid.io
      description: Production server
  /api/webhooks/{id}/deliveries:
    get:
      tags:
      - Webhooks
      summary: List webhook deliveries
      description: Delivery log with status, attempts, and response codes.
      operationId: listWebhookDeliveries
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: page
        in: query
        schema:
          type: integer
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 100
          default: 20
      responses:
        '200':
          description: Delivery attempts
          content:
            application/json:
              schema:
                type: object
                properties:
                  deliveries:
                    type: array
                    items:
                      $ref: '#/components/schemas/WebhookDelivery'
                required:
                - deliveries
                additionalProperties: true
              examples:
                verifiedResponse:
                  summary: Representative successful response
                  description: Illustrative values verified against the operation contract; identifiers and URLs are examples.
                  value:
                    deliveries:
                    - id: 123
                      jobId: 550e8400-e29b-41d4-a716-446655440000
                      event: render.completed
                      status: success
                      attempts: 1
                      responseStatus: 200
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
    servers:
    - url: https://api.zvid.io
      description: Production server
  /api/webhooks/{id}/test:
    post:
      tags:
      - Webhooks
      summary: Send test delivery
      operationId: testWebhook
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '202':
          description: Test event queued
          content:
            application/json:
              schema:
                type: object
                properties:
                  queued:
                    type: boolean
                  deliveryId:
                    type: integer
                required:
                - queued
                - deliveryId
                additionalProperties: true
              example:
                queued: true
                deliveryId: 123
              examples:
                verifiedResponse:
                  summary: Representative successful response
                  description: Illustrative values verified against the operation contract; identifiers and URLs are examples.
                  value:
                    queued: true
                    deliveryId: 123
        '400':
          description: Invalid input or semantic validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '404':
          description: Not found for this account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - ApiKeyAuth: []
      - BearerAuth: []
    servers:
    - url: https://api.zvid.io
      description: Production server
components:
  schemas:
    ValidationError:
      type: object
      properties:
        error:
          type: string
          example: Validation failed
        message:
          type: string
          example: Please check your input and try again
        details:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
                example: name
              message:
                type: string
                example: Name is required
            required:
            - field
            - message
            additionalProperties: false
        planLimits:
          type: object
          description: Present on render validation errors; contains the authenticated user's current render limits.
          additionalProperties: true
      required:
      - error
      additionalProperties: true
    WebhookRequest:
      type: object
      properties:
        url:
          type: string
          format: uri
          maxLength: 2048
        description:
          type: string
          maxLength: 255
        events:
          type: array
          minItems: 1
          uniqueItems: true
          items:
            enum:
            - render.completed
            - render.failed
      required:
      - url
      additionalProperties: false
    WebhookList:
      type: object
      properties:
        webhooks:
          type: array
          items:
            $ref: '#/components/schemas/Webhook'
        usage:
          $ref: '#/components/schemas/WebhookUsage'
      required:
      - webhooks
      - usage
      additionalProperties: true
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error type
        message:
          type: string
          description: Human-readable error message
      required:
      - error
      additionalProperties: true
    AuthenticationError:
      type: object
      properties:
        error:
          type: string
          description: Error type
          example: API key required
        message:
          type: string
          description: Human-readable error message
          example: Please provide an API key in the X-API-Key header or Authorization header
      required:
      - error
      additionalProperties: false
    WebhookDelivery:
      type: object
      properties:
        id:
          type: integer
        jobId:
          type: string
        event:
          type: string
          example: render.completed
        url:
          type: string
        status:
          type: string
          example: success
        attempts:
          type: integer
          description: Delivery attempts made (max 5, exponential backoff from 30s).
        responseStatus:
          anyOf:
          - type: integer
          - type: 'null'
        errorMessage:
          anyOf:
          - type: string
          - type: 'null'
        createdAt:
          type: string
        deliveredAt:
          anyOf:
          - type: string
          - type: 'null'
    WebhookUsage:
      type: object
      properties:
        used:
          type: integer
        limit:
          type: integer
        planName:
          type: string
      required:
      - used
      - limit
      - planName
      additionalProperties: true
    Webhook:
      type: object
      properties:
        id:
          type: string
        url:
          type: string
        description:
          type: string
        events:
          type: array
          items:
            enum:
            - render.completed
            - render.failed
        status:
          enum:
          - active
          - disabled
        secret:
          type: string
          description: Returned by creation and single-webhook lookup; omitted from list/update responses.
        consecutiveFailures:
          type: integer
        lastSuccessAt:
          anyOf:
          - type: string
          - type: 'null'
        lastFailureAt:
          anyOf:
          - type: string
          - type: 'null'
        lastFailureReason:
          anyOf:
          - type: string
          - type: 'null'
        createdAt:
          type: string
        updatedAt:
          type: string
      required:
      - id
      - url
      - events
      - status
      additionalProperties: true
    WebhookUpdate:
      type: object
      properties:
        url:
          type: string
          format: uri
          maxLength: 2048
        description:
          type: string
          maxLength: 255
        events:
          type: array
          minItems: 1
          uniqueItems: true
          items:
            enum:
            - render.completed
            - render.failed
        status:
          enum:
          - active
          - disabled
      additionalProperties: false
      minProperties: 1
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key for authentication. Create one in your dashboard.
    BearerAuth:
      type: http
      scheme: bearer
      description: 'Dashboard JWT in Authorization: Bearer <token>, only on operations that explicitly list this scheme. Prefer x-api-key for REST integrations. OAuth for hosted MCP is a separate connection at https://mcp.zvid.io/mcp.'
x-refined-from:
- openapi.yaml
- zvid-io-openapi.yaml