Send a test delivery JSON Schema

Source OpenAPI: 0xArchive API 1.6.1; 168 paths; 190 component schemas. Queue a webhook.test event to the endpoint so you can confirm your receiver and your signature verification work end to end. The delivery appears in the endpoint’s delivery log like any other. It is a real signed delivery, so it is priced like one: it counts against today’s delivery budget, and it is refused on a plan without webhook delivery or once that budget is spent. A refusal here never pauses a subscription. Authenticate with an API key or a signed-in dashboard session. Costs no credits.

Route Metadata

Field	Value
Method	`POST`
Path	`/v1/webhooks/endpoints/{id}/test`
operationId	`testWebhookEndpoint`
Tag	Webhooks - Endpoints
Family	Webhooks
Deprecated or legacy	no

Request Parameters

Path Parameters

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "testWebhookEndpoint path parameters",
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "description": "Endpoint identifier.",
      "type": "string",
      "format": "uuid",
      "example": "3c1f0a52-8d6b-4f0e-9b1a-6f2c4d8e9a10",
      "x-parameter-location": "path"
    }
  }
}

Response Contracts

Status 200

The test delivery was queued

application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "testWebhookEndpoint response 200",
  "description": "API response containing a newly queued delivery.",
  "type": "object",
  "properties": {
    "data": {
      "description": "A delivery that has just been queued.",
      "type": "object",
      "required": [
        "delivery_id",
        "event_id"
      ],
      "properties": {
        "delivery_id": {
          "description": "Delivery identifier. Read it back from the endpoint's delivery log.",
          "type": "string",
          "format": "uuid"
        },
        "event_id": {
          "description": "Event identifier carried in the delivered payload.",
          "type": "string",
          "format": "uuid"
        }
      }
    },
    "success": {
      "type": "boolean",
      "example": true
    }
  }
}

Status 400

Invalid request

application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "testWebhookEndpoint response 400",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    },
    "error_code": {
      "description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    }
  }
}

OpenAPI example

{
  "code": 400,
  "error": "Failed to deserialize query string: limit: invalid digit found in string",
  "error_code": "invalid_query_params",
  "request_id": "3f2a9c71-5b0e-4d68-9a4c-7e1d2b6f8a05"
}

Status 401

Authentication required

application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "testWebhookEndpoint response 401",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    },
    "error_code": {
      "description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    }
  }
}

OpenAPI example

{
  "code": 401,
  "error": "Missing or invalid API key. Provide X-API-Key header."
}

Status 404

Resource not found

application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "testWebhookEndpoint response 404",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    },
    "error_code": {
      "description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    }
  }
}

OpenAPI example

{
  "code": 404,
  "error": "Resource not found"
}

Status 409

Today’s delivery budget is already spent, so the test event was not queued. Send it after the budget resets.

application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "testWebhookEndpoint response 409",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    },
    "error_code": {
      "description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    }
  }
}

OpenAPI example

{
  "code": 409,
  "error": "The account is at today's limit of 5000 webhook deliveries. A test event counts against that limit, so it would not be sent. The daily allowance resets at 2026-09-21 00:00 UTC.",
  "request_id": "3f2a9c71-5b0e-4d68-9a4c-7e1d2b6f8a05"
}

Status 429

Rate limit exceeded

application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "testWebhookEndpoint response 429",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    },
    "error_code": {
      "description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    }
  }
}

OpenAPI example

{
  "code": 429,
  "error": "Rate limit exceeded"
}

API reference

SDKs & tooling

AI & agents

Send a test delivery JSON Schema

Route Metadata

Request Parameters

Path Parameters

Response Contracts

Status 200

application/json

Status 400

application/json

OpenAPI example

Status 401

application/json

OpenAPI example

Status 404

application/json

OpenAPI example

Status 409

application/json

OpenAPI example

Status 429

application/json

OpenAPI example

​Route Metadata

​Request Parameters

​Path Parameters

​Response Contracts

​Status 200

​application/json

​Status 400

​application/json

OpenAPI example

​Status 401

​application/json

OpenAPI example

​Status 404

​application/json

OpenAPI example

​Status 409

​application/json

OpenAPI example

​Status 429

​application/json

OpenAPI example

Route Metadata

Request Parameters

Path Parameters

Response Contracts

Status 200

application/json

Status 400

application/json

Status 401

application/json

Status 404

application/json

Status 409

application/json

Status 429

application/json