> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pulze.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Test

> Send a sample delivery, so an endpoint can be verified before a job depends on it



## OpenAPI

````yaml /renderflow/api-reference/openapi.json post /webhooks/{id}/test
openapi: 3.1.0
info:
  title: RenderFlow API
  version: 2.0.0
  description: Render farm management.
servers:
  - url: http://localhost:44442/api/v1
    description: The service on this machine. Answers without a credential
  - url: http://your-server:44442/api/v1
    description: A farm's server. Needs an API key
  - url: https://your-server:44445/api/v1
    description: A farm's server set up with TLS. Needs an API key
security:
  - bearerAuth: []
paths:
  /webhooks/{id}/test:
    post:
      tags:
        - Webhooks
      summary: Test
      description: >-
        Send a sample delivery, so an endpoint can be verified before a job
        depends on it
      operationId: testWebhook
      parameters:
        - schema:
            type: string
            pattern: ^[a-fA-F0-9]{24}$
            example: 68b1f0c2a4d3e5f6a7b8c9d0
          required: true
          name: id
          in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookTest'
      responses:
        '202':
          description: Queued, with the body it will carry
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookTestResult'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Not permitted for this credential
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '422':
          description: Validation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Unhandled server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    WebhookTest:
      type: object
      properties:
        event:
          $ref: '#/components/schemas/WebhookEvent'
          description: >-
            Which event to imitate. The first one this subscription asked for,
            by default
      additionalProperties: false
    WebhookTestResult:
      type: object
      properties:
        message:
          type: string
        payload:
          $ref: '#/components/schemas/WebhookPayload'
      required:
        - message
        - payload
    ApiError:
      type: object
      properties:
        error:
          type: string
        tag:
          type: string
          description: The catalog entry this failure is, when it is one
        title:
          type: string
          description: The catalog entry's title
        detail:
          type: string
          description: What happened this time, and what to do
        issues:
          type: array
          items:
            type: object
            properties:
              path:
                type: array
                items:
                  anyOf:
                    - type: string
                    - type: number
              message:
                type: string
            required:
              - path
              - message
      required:
        - error
    WebhookEvent:
      type: string
      enum:
        - job.created
        - job.started
        - job.completed
        - job.failed
        - job.suspended
        - job.resumed
        - job.removed
        - step.started
        - step.completed
        - step.failed
        - task.started
        - task.completed
        - task.failed
        - node.offline
        - node.online
        - node.error
    WebhookPayload:
      type: object
      properties:
        id:
          type: string
          description: >-
            The delivery id, the same across every attempt at one event.
            Deduplicate on it
        event:
          $ref: '#/components/schemas/WebhookEvent'
        at:
          type: integer
          example: 1785846207000
        farm:
          type: object
          properties:
            id:
              type:
                - string
                - 'null'
            name:
              type: string
          required:
            - id
            - name
          description: The server's id and hostname, the pair `GET /info` answers with
        job:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
            status:
              type: string
            user:
              type:
                - string
                - 'null'
              description: The submitting user's id, or null when nobody was signed in
            pool_id:
              type:
                - string
                - 'null'
          required:
            - id
            - name
            - status
            - user
            - pool_id
          description: On every `job.*`, `step.*` and `task.*`. A `node.*` has no job
        step:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
            index:
              type: integer
          required:
            - id
            - name
            - index
          description: On `step.*` and `task.*`
        task:
          type: object
          properties:
            id:
              type: string
            index:
              type: integer
          required:
            - id
            - index
          description: On `task.*`
        node:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
            status:
              type: string
            pool_id:
              type:
                - string
                - 'null'
          required:
            - id
            - name
            - status
            - pool_id
          description: On `node.*` only
      required:
        - id
        - event
        - at
        - farm
      description: >-
        Signed and sent as it is, so a signature can be checked against these
        exact bytes
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An API key from Settings, API Keys. A caller on this machine needs none.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.