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

# Test Superagent webhook

> <Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Sends a sample `message.completed` delivery to a Superagent's webhook, so you can check your endpoint.

The delivery is signed when the webhook has a secret, and carries a unique `X-Base44-Delivery` header. A successful call means the test ran, not that your endpoint accepted it. Read `ok` for that. A failed test doesn't count toward `consecutive_failures`.

Base44 waits up to 10 seconds for your endpoint to answer.

<Note>This endpoint accepts a personal API key or personal access token belonging to an editor of the agent. A read-only key is refused, and workspace API keys are not accepted.</Note>



## OpenAPI

````yaml /developers/references/app-management/app-management-openapi.json post /api/agents/{agent_id}/webhooks/{webhook_id}/test
openapi: 3.1.0
info:
  title: Base44 App Management API
  version: 1.0.0
servers:
  - url: https://app.base44.com
security:
  - PersonalAccessTokenAuth: []
paths:
  /api/agents/{agent_id}/webhooks/{webhook_id}/test:
    post:
      summary: Test Superagent webhook
      description: >-
        <Info>This API is in beta. Endpoints, fields, and behavior may still
        change, so avoid depending on it in production.</Info>


        Sends a sample `message.completed` delivery to a Superagent's webhook,
        so you can check your endpoint.


        The delivery is signed when the webhook has a secret, and carries a
        unique `X-Base44-Delivery` header. A successful call means the test ran,
        not that your endpoint accepted it. Read `ok` for that. A failed test
        doesn't count toward `consecutive_failures`.


        Base44 waits up to 10 seconds for your endpoint to answer.


        <Note>This endpoint accepts a personal API key or personal access token
        belonging to an editor of the agent. A read-only key is refused, and
        workspace API keys are not accepted.</Note>
      operationId: test_webhook_api_agents__agent_id__webhooks__webhook_id__test_post
      parameters:
        - name: webhook_id
          in: path
          required: true
          schema:
            type: string
            description: >-
              ID of the webhook to test. Get it from [List Superagent
              webhooks](/api-reference/list-superagent-webhooks).
            title: Webhook Id
          description: >-
            ID of the webhook to test. Get it from [List Superagent
            webhooks](/api-reference/list-superagent-webhooks).
          example: 68a1d0f4f0b9d3002e7a5c52
        - name: agent_id
          in: path
          required: true
          schema:
            type: string
            description: >-
              ID of the Superagent. It's the agent's app ID, shown in the
              agent's developer settings.
            title: Agent Id
          description: >-
            ID of the Superagent. It's the agent's app ID, shown in the agent's
            developer settings.
          example: 6820f3a4e7b91d003c45a1f2
      responses:
        '200':
          description: How your endpoint answered the test.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuperagentWebhookTestResult'
        '400':
          description: '`agent_id` belongs to an app that isn''t a Superagent.'
        '401':
          description: Missing or invalid credentials.
        '402':
          description: Agent webhooks need the Builder plan or higher.
        '403':
          description: >-
            You aren't an editor of this agent, you're a viewer in its
            workspace, your API key is read-only, or you used a workspace API
            key.
        '404':
          description: Agent or webhook not found.
        '429':
          description: Rate limit exceeded (100 requests per minute).
components:
  schemas:
    SuperagentWebhookTestResult:
      properties:
        ok:
          type: boolean
          title: Ok
          description: Whether your endpoint answered with a 2xx status.
          example: true
        status_code:
          anyOf:
            - type: integer
            - type: 'null'
          title: Status Code
          description: >-
            HTTP status your endpoint answered with. Present only when it
            answered.
          example: 200
        response_body:
          anyOf:
            - type: string
            - type: 'null'
          title: Response Body
          description: >-
            Start of your endpoint's response body, up to 1,024 bytes. Present
            only when it answered.
          example: ok
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
          description: >-
            Why the delivery didn't get an answer, such as a timeout or a URL
            Base44 refuses to call. Present only when it didn't.
          example: 'ConnectTimeout: timed out'
      type: object
      required:
        - ok
      title: SuperagentWebhookTestResult
      description: The outcome of a test delivery.
  securitySchemes:
    PersonalAccessTokenAuth:
      type: http
      scheme: bearer
      description: 'Personal access token, sent as `Authorization: Bearer <token>`.'

````

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