Open in ChatGPT
View as Markdown

Fire a synthetic test event for a webhook subscription

POST /v1/webhooks/{subscriptionId}/test
Base URL 
https://api.isnotai.com

Authenticate with Authorization: Bearer aik_v1_... (preferred) or the x-api-key header. Keys are region-bound. Authentication

Available Regions 2 regions

Fires one synthetic delivery to the subscription URL using the currently stored secret and reports the outcome inline (no retries; does not count toward auto-disable). Unlike real deliveries - whose payload is the flat event object with metadata in headers - the test payload is a wrapper: { eventType, integrationId, timestamp, data: { test: true, message, subscriptionId, deliveryId } }. The request carries X-Webhook-Test: true.

Path Parameters

subscriptionId
string Required

Subscription id.

Responses

Any authenticated route can also return 401 (missing or invalid key), 429 RATE_LIMITED (edge rate limit; Retry-After is an integer number of seconds), and 5xx errors, even where not listed below. See Error Handling and Rate Limits.

200 application/json

Payload of WebhookTestResponse

Show 1 response attribute Hide response attributes
data
object
Show 5 data attributes Hide data attributes
deliveryId
string
status
string

Delivery outcome: one of Pending, Delivered, Failed, MaxRetriesExceeded, PermanentFailure, PoisonAborted.

responseCode
integer(int32)
errorClass
string
attempts
integer(int32)
401 application/json

Payload of ErrorEnvelope

Show 1 response attribute Hide response attributes
error
object
Show 3 error attributes Hide error attributes
code
string Required
message
string Required
details
object Required

Always present and null unless the error carries field-level context (validation errors set details.field to the offending parameter name).

404 application/json

Payload of ErrorEnvelope

Show 1 response attribute Hide response attributes
error
object
Show 3 error attributes Hide error attributes
code
string Required
message
string Required
details
object Required

Always present and null unless the error carries field-level context (validation errors set details.field to the offending parameter name).

POST /v1/webhooks/{subscriptionId}/test 
curl --request POST \
  --url https://api.isnotai.com/v1/webhooks/your-subscriptionId/test \
  --header 'Authorization: Bearer aik_v1_YOUR_API_KEY'
import requests

url = "https://api.isnotai.com/v1/webhooks/your-subscriptionId/test"

headers = {"Authorization": "Bearer aik_v1_YOUR_API_KEY"}

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

print(response.json())
const fetch = require('node-fetch');

const url = 'https://api.isnotai.com/v1/webhooks/your-subscriptionId/test';
const options = {method: 'POST', headers: {Authorization: 'Bearer aik_v1_YOUR_API_KEY'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://api.isnotai.com/v1/webhooks/your-subscriptionId/test"),
    Headers =
    {
        { "Authorization", "Bearer aik_v1_YOUR_API_KEY" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Try it

Collapse

Sent to the API as Authorization: Bearer aik_v1_.... Held only in this tab's input element; re-enter on each browser tab. The docs site never receives or stores it.

Path parameters

Subscription id.

200 Response examples 
{
  "data": {
    "deliveryId": "string",
    "status": "string",
    "responseCode": 0,
    "errorClass": "string",
    "attempts": 0
  }
}
401 Response examples 
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
404 Response examples 
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}