> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://platform.bctrl.ai/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://platform.bctrl.ai/_mcp/server.

# Test a webhook

POST https://api.bctrl.ai/v1/webhooks/{webhookId}/test

Queue a signed test event for a webhook endpoint and return its delivery record.

Reference: https://platform.bctrl.ai/api/api-reference/webhooks/test

## Authentication

- `Authorization` header (bearer token, required) — Use Bearer \<api-key>.

## Servers

- `https://api.bctrl.ai` (Production, default)
- `http://localhost:8787` (Local development gateway)

## Request

### Path parameters

- `webhookId` (string, required) — Unique webhook identifier generated by BCTRL.

### Headers

- `BCTRL-Subaccount-Id` (string, optional) — Optional effective subaccount context for organization API keys. Subaccount API keys are already scoped and cannot use this header to act as another subaccount.

## Response

### 202

Accepted

- `attemptCount` (integer, required)
- `createdAt` (datetime, required) — RFC 3339 timestamp with a UTC offset.
- `eventId` (string, required) — Unique runEvent identifier generated by BCTRL.
- `eventType` (string, required)
- `id` (string, required) — Unique webhookDelivery identifier generated by BCTRL.
- `lastError` (string, required, nullable)
- `nextAttemptAt` (datetime, required, nullable) — RFC 3339 timestamp with a UTC offset.
- `responseStatus` (integer, required, nullable)
- `sentAt` (datetime, required, nullable) — RFC 3339 timestamp with a UTC offset.
- `status` (enum, required)
  - Allowed values: `pending`, `sending`, `sent`, `failed`, `cancelled`
- `updatedAt` (datetime, required) — RFC 3339 timestamp with a UTC offset.
- `webhookId` (string, required, nullable)

## Examples

**Response**

```json
{
  "attemptCount": 1,
  "createdAt": "2026-07-26T12:00:00Z",
  "eventId": "evt_AAAAAAAAAAAAAAAAAAAAAA",
  "eventType": "string",
  "id": "whd_AAAAAAAAAAAAAAAAAAAAAA",
  "lastError": "string",
  "nextAttemptAt": "2026-07-26T12:00:00Z",
  "responseStatus": 1,
  "sentAt": "2026-07-26T12:00:00Z",
  "status": "pending",
  "updatedAt": "2026-07-26T12:00:00Z",
  "webhookId": "wh_AAAAAAAAAAAAAAAAAAAAAA"
}
```

**SDK Code**

```python
import requests

url = "https://api.bctrl.ai/v1/webhooks/webhookId/test"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.bctrl.ai/v1/webhooks/webhookId/test';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bctrl.ai/v1/webhooks/webhookId/test"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.bctrl.ai/v1/webhooks/webhookId/test")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.bctrl.ai/v1/webhooks/webhookId/test")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.bctrl.ai/v1/webhooks/webhookId/test', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.bctrl.ai/v1/webhooks/webhookId/test");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.bctrl.ai/v1/webhooks/webhookId/test")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```