RedRover Logo

Webhooks

Send a Test Event

Sends a signed webhook.test event to the endpoint right away and returns how it went.

POST/webhooks/{id}/test
Scope: webhooks:write

One try, no retries. Works on endpoints that are turned off, so you can check a fix before turning one back on.

Headers

  • AuthorizationstringRequired

    Bearer followed by an rr_live_ API key or a connected app's access token. See Authentication.

  • X-Workspace-IdstringRequired

    The workspace to act on, from List Workspaces.

    UUID

Path Parameters

Response

200 The delivery. status is succeeded when your endpoint answered with a 2xx.

  • dataobjectRequired
    Show 11 Child Fields
    • idstringRequired

      Delivery ID, sent as RedRover-Delivery-Id

    • eventIdstringRequired

      Event ID, the payload's id

    • eventTypestringRequired

      The event type

      one of post.scheduled, post.posted, post.failed, post.needs_approval, post.cancelled, comment.scheduled, comment.posted, comment.failed, comment.needs_approval, comment.cancelled, review.note_added, client.created, client.updated, credits.low, client.cap_reached, webhook.test

    • statusstringRequired

      pending while retries remain

      one of pending, succeeded, failed

    • attemptsintegerRequired

      Attempts made so far

    • responseStatusintegerRequired

      The HTTP status your endpoint answered on the last attempt

      nullable

    • errorstringRequired

      What went wrong on the last attempt

      nullable

    • durationMsintegerRequired

      How long the last attempt took

      nullable

    • createdAtstringRequired

      ISO 8601 datetime

    • lastAttemptAtstringRequired

      ISO 8601 datetime

      nullable

    • nextAttemptAtstringRequired

      When the next retry is due, while pending

      nullable

Errors

Every error uses the error envelope.

  • 404No webhook endpoint with this ID in the workspace
  • 401The Authorization header is missing, or the key is invalid or revoked
  • 403The key lacks the endpoint's scope, or cannot reach the workspace
  • 429More than 120 requests in a minute. Wait for Retry-After seconds
  • 500Something went wrong on our side
curl -X POST "https://app.tryredrover.com/api/public/v1/webhooks/5d2f8a1c-4b6e-4f3a-9d7c-1e8b2a6f0c93/test" \
  -H "Authorization: Bearer $REDROVER_API_KEY" \
  -H "X-Workspace-Id: $REDROVER_WORKSPACE_ID"
200 Response
{
  "data": {
    "id": "0c4e8a2f-6b1d-4e3a-a5c7-9f2b4d6e8a1c",
    "eventId": "e7a1c3f5-2b4d-4c6e-8f0a-1b3d5f7a9c2e",
    "eventType": "webhook.test",
    "status": "succeeded",
    "attempts": 1,
    "responseStatus": 200,
    "error": null,
    "durationMs": 184,
    "createdAt": "2026-11-15T15:01:04Z",
    "lastAttemptAt": "2026-11-15T15:01:05Z",
    "nextAttemptAt": null
  }
}