Test webhook endpoint

Sends a test event to the webhook endpoint

POST /webhook_endpoints/{id}/test

Typescript (SDK)

TypeScript

import { Crevio } from "@crevio/sdk";

const crevio = new Crevio({
  apiKey: process.env["CREVIO_API_KEY"] ?? "",
});

async function run() {
  const result = await crevio.webhookEndpoints.test({
    id: "<id>",
  });

  console.log(result);
}

run();

200

{
  "delivered": true,
  "message": "<string>"
}

Authorizations

Authorization · string · header · required

API key in the format: Bearer {api_token}

Path Parameters

id · string · required

The resource ID (e.g., "prod_abc123") or slug (e.g., "my-product")

Query Parameters

event_type · string

The event type to send as a test

Response

200

application/json

Test event delivered

delivered · boolean

message · string