Skip to main content

UpdateAppWebhookArgs

type UpdateAppWebhookArgs = {
  appId: string;
  callbackUrl: string;
  events: readonly WebhookEvent[];
  version?: WebhookVersion;
};

Arguments for configuring (creating or updating) an app webhook.

Properties​

appId​

appId: string;

The application ID.

callbackUrl​

callbackUrl: string;

The URL the webhook will POST events to.

events​

events: readonly WebhookEvent[];

Events the webhook should receive. Must be unique.

version?​

optional version: WebhookVersion;

Webhook payload version. Defaults to the backend's latest supported version.