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/vidplate-app:vidplate-app-webhook-endpoints-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: VidPlate Webhook endpoints API
  version: v1
  summary: Render video and images from your own templates, on your own machines.
  description: 'Server-to-server only: send your secret key as "Authorization: Bearer vpk_live_...". Requests from a browser are refused, and a secret key must never be put in a web page or an app.


    Every response carries X-Request-Id. Errors use one shape (see the Error schema) with stable codes. Lists use cursor pagination: pass next_cursor as starting_after.


    Rate limits are per key and per workspace, with RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset headers, and Retry-After on 429.


    Renders run on your workspace''s own Browser Nodes (the render-nodes endpoints) and are not charged per render; paid API plans have a daily render limit and a monthly video-minutes allowance (429 quota_exceeded and 429 video_minutes_exceeded); Studio Pro has 10,000 static outputs and 2,000 video minutes a calendar month (429 static_outputs_exceeded and 429 video_minutes_exceeded) plus a daily safety limit (429 quota_exceeded); the Sandbox has one-off totals for its whole trial (402 sandbox_allowance_used). Webhooks are signed (VidPlate-Signature: t=..., v1=HMAC-SHA256 of "t.body") and carry IDs and statuses only.'
servers:
- url: https://api.vidplate.app/v1
  description: VidPlate API
- url: https://vidplate.app/api/v1
  description: Legacy base URL. It keeps working for existing integrations.
security:
- apiKey: []
tags:
- name: Webhook Endpoints
  description: Where VidPlate sends render and template events.
paths:
  /webhook-endpoints:
    get:
      operationId: listWebhookEndpoints
      tags:
      - Webhook Endpoints
      summary: List webhook endpoints
      security:
      - apiKey: []
      x-required-scopes:
      - webhooks:manage
      responses:
        '200':
          description: The endpoints.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookEndpointList'
        '401':
          description: 'Error. Codes: invalid_api_key.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: authentication_failed
                  code: invalid_api_key
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '403':
          description: 'Error. Codes: missing_scope, plan_not_eligible.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: permission_denied
                  code: missing_scope
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '429':
          description: 'Error. Codes: too_many_requests.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: rate_limited
                  code: too_many_requests
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '500':
          description: 'Error. Codes: internal_error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: api_error
                  code: internal_error
                  message: '...'
                  request_id: req_0123456789abcdef01234567
    post:
      operationId: createWebhookEndpoint
      tags:
      - Webhook Endpoints
      summary: Register a webhook endpoint
      description: 'The signing secret (whsec_...) is in this response only. Events are signed with VidPlate-Signature: t=,v1=. Bodies carry IDs and statuses, never download URLs. An endpoint receives only the events it lists, so render.progress (one event per output) reaches it only if you add it.'
      security:
      - apiKey: []
      x-required-scopes:
      - webhooks:manage
      parameters:
      - name: Idempotency-Key
        in: header
        required: false
        description: Any unique string (1 to 255 visible characters). Sending the same key with the same body returns the first response; with a different body, 409 idempotency_key_reused. Kept 24 hours.
        schema:
          type: string
          maxLength: 255
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              required:
              - url
              - events
              properties:
                url:
                  type: string
                  format: uri
                  maxLength: 2048
                  description: HTTPS only. Private, loopback and VidPlate addresses are refused.
                events:
                  type: array
                  minItems: 1
                  uniqueItems: true
                  items:
                    enum:
                    - render.completed
                    - render.failed
                    - render.waiting_for_node
                    - render.expired
                    - render.progress
                    - template.version.published
                    - render_node.online
                    - render_node.offline
                    - output.delivered
                    - output.delivery_failed
                description:
                  type:
                  - string
                  - 'null'
                  maxLength: 200
            example:
              url: https://example.com/vidplate/webhooks
              events:
              - render.completed
              - render.failed
              description: Production
      responses:
        '201':
          description: The endpoint, with its secret.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookEndpoint'
              example:
                object: webhook_endpoint
                id: whe_6729c0a1b2c3d4e5f6a7b8aa
                url: https://example.com/vidplate/webhooks
                description: Production
                events:
                - render.completed
                - render.failed
                enabled: true
                disabled_reason: null
                created_at: '2026-11-01T09:00:00.000Z'
                secret: whsec_...
        '400':
          description: 'Error. Codes: invalid_events.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: invalid_request
                  code: invalid_events
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '401':
          description: 'Error. Codes: invalid_api_key.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: authentication_failed
                  code: invalid_api_key
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '403':
          description: 'Error. Codes: missing_scope, plan_not_eligible.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: permission_denied
                  code: missing_scope
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '409':
          description: 'Error. Codes: endpoint_limit_reached.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: conflict
                  code: endpoint_limit_reached
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '429':
          description: 'Error. Codes: too_many_requests.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: rate_limited
                  code: too_many_requests
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '500':
          description: 'Error. Codes: internal_error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: api_error
                  code: internal_error
                  message: '...'
                  request_id: req_0123456789abcdef01234567
  /webhook-endpoints/{webhook_endpoint_id}:
    get:
      operationId: getWebhookEndpoint
      tags:
      - Webhook Endpoints
      summary: Get a webhook endpoint
      security:
      - apiKey: []
      x-required-scopes:
      - webhooks:manage
      parameters:
      - name: webhook_endpoint_id
        in: path
        required: true
        description: Webhook endpoint ID.
        schema:
          type: string
          pattern: ^whe_
        example: whe_6729c0a1b2c3d4e5f6a7b8aa
      responses:
        '200':
          description: The endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookEndpoint'
              example:
                object: webhook_endpoint
                id: whe_6729c0a1b2c3d4e5f6a7b8aa
                url: https://example.com/vidplate/webhooks
                description: Production
                events:
                - render.completed
                - render.failed
                enabled: true
                disabled_reason: null
                created_at: '2026-11-01T09:00:00.000Z'
        '401':
          description: 'Error. Codes: invalid_api_key.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: authentication_failed
                  code: invalid_api_key
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '403':
          description: 'Error. Codes: missing_scope, plan_not_eligible.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: permission_denied
                  code: missing_scope
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '404':
          description: 'Error. Codes: webhook_endpoint_not_found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: not_found
                  code: webhook_endpoint_not_found
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '429':
          description: 'Error. Codes: too_many_requests.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: rate_limited
                  code: too_many_requests
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '500':
          description: 'Error. Codes: internal_error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: api_error
                  code: internal_error
                  message: '...'
                  request_id: req_0123456789abcdef01234567
    post:
      operationId: updateWebhookEndpoint
      tags:
      - Webhook Endpoints
      summary: Change a webhook endpoint
      security:
      - apiKey: []
      x-required-scopes:
      - webhooks:manage
      parameters:
      - name: webhook_endpoint_id
        in: path
        required: true
        description: Webhook endpoint ID.
        schema:
          type: string
          pattern: ^whe_
        example: whe_6729c0a1b2c3d4e5f6a7b8aa
      - name: Idempotency-Key
        in: header
        required: false
        description: Any unique string (1 to 255 visible characters). Sending the same key with the same body returns the first response; with a different body, 409 idempotency_key_reused. Kept 24 hours.
        schema:
          type: string
          maxLength: 255
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              required: []
              properties:
                url:
                  type: string
                  format: uri
                  maxLength: 2048
                  description: HTTPS only. Private, loopback and VidPlate addresses are refused.
                events:
                  type: array
                  minItems: 1
                  uniqueItems: true
                  items:
                    enum:
                    - render.completed
                    - render.failed
                    - render.waiting_for_node
                    - render.expired
                    - render.progress
                    - template.version.published
                    - render_node.online
                    - render_node.offline
                    - output.delivered
                    - output.delivery_failed
                description:
                  type:
                  - string
                  - 'null'
                  maxLength: 200
                enabled:
                  type: boolean
            example:
              events:
              - render.completed
              enabled: true
      responses:
        '200':
          description: The endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookEndpoint'
        '401':
          description: 'Error. Codes: invalid_api_key.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: authentication_failed
                  code: invalid_api_key
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '403':
          description: 'Error. Codes: missing_scope, plan_not_eligible.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: permission_denied
                  code: missing_scope
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '404':
          description: 'Error. Codes: webhook_endpoint_not_found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: not_found
                  code: webhook_endpoint_not_found
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '429':
          description: 'Error. Codes: too_many_requests.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: rate_limited
                  code: too_many_requests
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '500':
          description: 'Error. Codes: internal_error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: api_error
                  code: internal_error
                  message: '...'
                  request_id: req_0123456789abcdef01234567
    delete:
      operationId: deleteWebhookEndpoint
      tags:
      - Webhook Endpoints
      summary: Delete a webhook endpoint
      security:
      - apiKey: []
      x-required-scopes:
      - webhooks:manage
      parameters:
      - name: webhook_endpoint_id
        in: path
        required: true
        description: Webhook endpoint ID.
        schema:
          type: string
          pattern: ^whe_
        example: whe_6729c0a1b2c3d4e5f6a7b8aa
      responses:
        '200':
          description: Deleted.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  deleted:
                    type: boolean
              example:
                object: webhook_endpoint
                id: whe_6729c0a1b2c3d4e5f6a7b8aa
                deleted: true
        '401':
          description: 'Error. Codes: invalid_api_key.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: authentication_failed
                  code: invalid_api_key
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '403':
          description: 'Error. Codes: missing_scope, plan_not_eligible.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: permission_denied
                  code: missing_scope
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '404':
          description: 'Error. Codes: webhook_endpoint_not_found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: not_found
                  code: webhook_endpoint_not_found
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '429':
          description: 'Error. Codes: too_many_requests.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: rate_limited
                  code: too_many_requests
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '500':
          description: 'Error. Codes: internal_error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: api_error
                  code: internal_error
                  message: '...'
                  request_id: req_0123456789abcdef01234567
  /webhook-endpoints/{webhook_endpoint_id}/rotate-secret:
    post:
      operationId: rotateWebhookSecret
      tags:
      - Webhook Endpoints
      summary: Replace the signing secret
      description: The new secret is in this response only. For 24 hours both secrets sign every event (two v1= values), so receivers can switch over.
      security:
      - apiKey: []
      x-required-scopes:
      - webhooks:manage
      parameters:
      - name: webhook_endpoint_id
        in: path
        required: true
        description: Webhook endpoint ID.
        schema:
          type: string
          pattern: ^whe_
        example: whe_6729c0a1b2c3d4e5f6a7b8aa
      - name: Idempotency-Key
        in: header
        required: false
        description: Any unique string (1 to 255 visible characters). Sending the same key with the same body returns the first response; with a different body, 409 idempotency_key_reused. Kept 24 hours.
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: The endpoint, with its new secret.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookEndpoint'
        '401':
          description: 'Error. Codes: invalid_api_key.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: authentication_failed
                  code: invalid_api_key
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '403':
          description: 'Error. Codes: missing_scope, plan_not_eligible.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: permission_denied
                  code: missing_scope
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '404':
          description: 'Error. Codes: webhook_endpoint_not_found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: not_found
                  code: webhook_endpoint_not_found
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '429':
          description: 'Error. Codes: too_many_requests.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: rate_limited
                  code: too_many_requests
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '500':
          description: 'Error. Codes: internal_error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: api_error
                  code: internal_error
                  message: '...'
                  request_id: req_0123456789abcdef01234567
  /webhook-endpoints/{webhook_endpoint_id}/test:
    post:
      operationId: testWebhookEndpoint
      tags:
      - Webhook Endpoints
      summary: Send a ping event now
      security:
      - apiKey: []
      x-required-scopes:
      - webhooks:manage
      parameters:
      - name: webhook_endpoint_id
        in: path
        required: true
        description: Webhook endpoint ID.
        schema:
          type: string
          pattern: ^whe_
        example: whe_6729c0a1b2c3d4e5f6a7b8aa
      responses:
        '200':
          description: What the endpoint answered.
          content:
            application/json:
              schema:
                type: object
        '401':
          description: 'Error. Codes: invalid_api_key.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: authentication_failed
                  code: invalid_api_key
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '403':
          description: 'Error. Codes: missing_scope, plan_not_eligible.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: permission_denied
                  code: missing_scope
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '404':
          description: 'Error. Codes: webhook_endpoint_not_found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: not_found
                  code: webhook_endpoint_not_found
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '429':
          description: 'Error. Codes: too_many_requests.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: rate_limited
                  code: too_many_requests
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '500':
          description: 'Error. Codes: internal_error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: api_error
                  code: internal_error
                  message: '...'
                  request_id: req_0123456789abcdef01234567
components:
  schemas:
    WebhookEndpoint:
      type: object
      properties:
        object:
          const: webhook_endpoint
        id:
          type: string
        url:
          type: string
        description:
          type:
          - string
          - 'null'
        events:
          type: array
          items:
            enum:
            - render.completed
            - render.failed
            - render.waiting_for_node
            - render.expired
            - render.progress
            - template.version.published
            - render_node.online
            - render_node.offline
            - output.delivered
            - output.delivery_failed
        enabled:
          type: boolean
        disabled_reason:
          type:
          - string
          - 'null'
        last_success_at:
          type:
          - string
          - 'null'
        last_failure_at:
          type:
          - string
          - 'null'
        created_at:
          type:
          - string
          - 'null'
        secret:
          type: string
          description: Only when created or rotated.
    WebhookEndpointList:
      type: object
      properties:
        object:
          const: list
        data:
          type: array
          items:
            $ref: '#/components/schemas/WebhookEndpoint'
        has_more:
          type: boolean
        next_cursor:
          type:
          - string
          - 'null'
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - type
          - code
          - message
          - request_id
          properties:
            type:
              enum:
              - invalid_request
              - payment_required
              - authentication_failed
              - permission_denied
              - not_found
              - conflict
              - unprocessable
              - rate_limited
              - api_error
              - service_unavailable
            code:
              type: string
              description: Stable, documented code.
            message:
              type: string
            param:
              type: string
              description: The request field the error is about, when there is one.
            errors:
              type: array
              description: Every problem found (schema_validation_failed).
              items:
                type: object
                properties:
                  param:
                    type: string
                  code:
                    type: string
                  message:
                    type: string
            request_id:
              type: string
              description: Quote this when asking for help.
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: vpk_live_...
      description: 'Workspace keys, created by workspace admins in VidPlate under Admin, then API. Scopes: templates:read (List templates, versions and their input schemas.); uploads:write (Upload images and video to use in renders.); renders:write (Create, cancel and retry renders.); renders:read (Check render status and download outputs.); webhooks:manage (Register and change webhook endpoints.); assets:read (Use Asset Library files as render inputs.); ai:spend (Allow renders that use AI voiceover or AI Recipes. These spend your AI credits.); render_nodes:read (See whether your render nodes are online, busy or offline, and what they can render.); storage_destinations:manage (Add, change, test and delete your own buckets that outputs are delivered to (Growth and above).)'