Usage
Webhooks
Create and manage webhooks for your apps
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Create and manage webhooks for your apps
const webhook = await vartiq.webhook.create({
name: "Webhook name",
url: "https://your-webhook-url.com",
appId: "APP_ID",
customHeaders: [{ key: "x-app", value: "x-value" }], // optional
authMethod: "basic", // optional: "basic", "hmac", or "apiKey"
userName: "username", // required if authMethod is "basic"
password: "password", // required if authMethod is "basic"
apiKey: "api-key", // required if authMethod is "apiKey"
apiKeyHeader: "x-api-key", // required if authMethod is "apiKey"
hmacHeader: "x-signature", // required if authMethod is "hmac"
hmacSecret: "your-secret" // required if authMethod is "hmac"
});
const webhook = await vartiq.webhook.create({
projectId: "PROJECT_ID",
environmentId: "ENVIRONMENT_ID",
url: "https://your-webhook-url.com",
customHeaders: [{ key: "x-key", value: "x-value" }], // optional
authMethod: "basic", // optional: "basic", "hmac", or "apiKey"
userName: "username", // required if authMethod is "basic"
password: "password", // required if authMethod is "basic"
apiKey: "api-key", // required if authMethod is "apiKey"
apiKeyHeader: "x-api-key", // required if authMethod is "apiKey"
hmacHeader: "x-signature", // required if authMethod is "hmac"
hmacSecret: "your-secret" // required if authMethod is "hmac"
});
const webhooks = await vartiq.webhook.list("APP_ID");
const webhook = await vartiq.webhook.get("WEBHOOK_ID");
const webhook = await vartiq.webhook.update("WEBHOOK_ID", {
name: "New name", // optional
url: "https://new-url.com" // optional
});
await vartiq.webhook.delete("WEBHOOK_ID");