---
title: "Test webhook"
method: POST
path: "/v2/webhooks/{webhookId}/test"
tags: ["Webhooks/Webhooks"]
---

# Test webhook

`POST /v2/webhooks/{webhookId}/test`

Tests a webhook. Creates a webhook dispatch with a dummy payload.

## Path parameters

- `webhookId` string, required

## Response `201`

- TestWebhookResponse
  - `data` WebhookDispatch, required
    - `id` string, required
    - `userId` string, required
    - `webhookId` string, required
    - `createdAt` string, date-time, required
    - `status` 'ACTIVE' | 'SUCCEEDED' | 'FAILED', required — Status of the webhook dispatch indicating whether the HTTP request was successful.
    - `eventType` 'ACTOR.BUILD.ABORTED' | 'ACTOR.BUILD.CREATED' | 'ACTOR.BUILD.FAILED' | 'ACTOR.BUILD.SUCCEEDED' | 'ACTOR.BUILD.TIMED_OUT' | 'ACTOR.RUN.ABORTED' | 'ACTOR.RUN.CREATED' | 'ACTOR.RUN.FAILED' | 'ACTOR.RUN.RESURRECTED' | 'ACTOR.RUN.SUCCEEDED' | 'ACTOR.RUN.TIMED_OUT' | 'TEST', required — Type of event that triggers the webhook.
    - `eventData` object, nullable
      - `actorId` string, required
      - `actorRunId` string
      - `actorBuildId` string
      - `actorTaskId` string, nullable
    - `webhook` WebhookDispatchWebhookSummary — A summary of the webhook that triggered this dispatch.
      - `actionType` string
      - `condition` WebhookCondition
        - `actorId` string, nullable
        - `actorTaskId` string, nullable
        - `actorRunId` string, nullable
      - `requestUrl` string, uri, nullable — URL of the HTTP request sent by the webhook. It is `null` for hook actions other than the conventional HTTP case (e.g. Slack or email notifications).
      - `isAdHoc` boolean
    - `calls` object[]
      - `startedAt` string, date-time, nullable
      - `finishedAt` string, date-time, nullable
      - `errorMessage` string, nullable
      - `responseStatus` integer, nullable
      - `responseBody` string, nullable

## Other responses

- `400` — Bad request - invalid input parameters or request body.
- `401` — Unauthorized - authentication required or invalid token.
- `403` — Forbidden - insufficient permissions to perform this action.
- `404` — Not found - the requested resource does not exist.
- `405` — Method not allowed.
- `429` — Too many requests - rate limit exceeded.

---

[API](https://skmtc.net/apify/apis/apify-api.md) · [All operations](https://skmtc.net/apify/apis/apify-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/apify/apify-api/versions/01a71794279b/schema)