api.triggerWebhook() - RevoEngine

`api.triggerWebhook()`

Schedules a webhook delivery. Notes:

Pass { scheduleFor }; the maximum horizon is 30 days.
Retired positional date and relative-delay arguments are ignored.
Unavailable with readOnly: true (throws an error).

Signature

static triggerWebhook(
      webhook: WebhookInput,
      options?: AutomationScheduleOptions,
    ): Promise<Webhook>;

Example

const webhook = await api.triggerWebhook({
  request: {
    url: 'https://example.com/hook',
    method: 'POST',
    body: { ok: true },
  },
}, {
  scheduleFor: new Date(Date.now() + 5 * 60 * 1000).toISOString(),
});

See all api methods or runtime basics.

Last modified on November 8, 2026