Skip to content
Shortcut: /, ⌘K or Ctrl+K

polymorfa webhook

Inspect and manage developer webhooks.

Polymorfa CLI · CLI API requests

View as Markdown

polymorfa webhook create

Create a webhook from one JSON object.

Usage

polymorfa webhook create [flags]

Flags

  • --idempotency-key <value>takes a value

    Use this key to identify retries; one is generated when omitted.

  • --input <value>takes a valuerequired

    Read the webhook JSON object from a file or stdin (-).

  • --phone-offline-start-day <value>takes a value

    First day without the phone on which the webhook receives session.phone_offline (7-13), or off to remove that event. WhatsApp signs the device out on day 14.

  • --secret-out <value>takes a value

    Write the one-time signing secret to a new mode-0600 file.

Also accepts the global flags.

polymorfa webhook delete

Delete one webhook.

Usage

polymorfa webhook delete WEBHOOK [flags]

Arguments

  • WEBHOOKrequired

    Webhook ID.

Flags

  • --idempotency-key <value>takes a value

    Use this key to identify retries; one is generated when omitted.

  • --yesboolean

    Confirm the external effect without prompting.

Also accepts the global flags.

polymorfa webhook delivery attempt list

List immutable attempts for a webhook delivery.

Usage

polymorfa webhook delivery attempt list DELIVERY [flags]

Arguments

  • DELIVERYrequired

    Delivery ID.

Flags

  • --cursor <value>takes a value

    Continue from this opaque cursor.

  • --limit <value>takes a value

    Request this many resources per page.

    Default 25
  • --max-items <value>takes a value

    Stop automatic pagination after this many resources.

  • --paginateboolean

    Request consecutive pages until --max-items resources are collected or no pages remain. Requires --max-items.

Also accepts the global flags.

polymorfa webhook delivery attempt view

View one immutable webhook delivery attempt.

Usage

polymorfa webhook delivery attempt view DELIVERY ATTEMPT [flags]

Arguments

  • DELIVERYrequired

    Delivery ID.

  • ATTEMPTrequired

    Attempt ID.

Flags

Also accepts the global flags.

polymorfa webhook delivery list

List webhook deliveries.

Usage

polymorfa webhook delivery list [flags]

Flags

  • --cursor <value>takes a value

    Continue from this opaque cursor.

  • --event <value>takes a value

    Filter by event ID.

  • --limit <value>takes a value

    Request this many resources per page.

    Default 25
  • --max-items <value>takes a value

    Stop automatic pagination after this many resources.

  • --paginateboolean

    Request consecutive pages until --max-items resources are collected or no pages remain. Requires --max-items.

  • --since <value>takes a value

    Include deliveries at or after this RFC 3339 time.

  • --status <value>takes a value

    Filter by delivery status.

    Allowed valuespendingdeliveringretryingsucceededfailed
  • --until <value>takes a value

    Exclude deliveries at or after this RFC 3339 time.

  • --webhook <value>takes a value

    Filter by webhook ID.

Also accepts the global flags.

polymorfa webhook delivery retry

Append a new immutable attempt to a webhook delivery.

Usage

polymorfa webhook delivery retry DELIVERY [flags]

Arguments

  • DELIVERYrequired

    Delivery ID.

Flags

  • --idempotency-key <value>takes a value

    Use this key to identify retries; one is generated when omitted.

  • --yesboolean

    Confirm the external effect without prompting.

Also accepts the global flags.

polymorfa webhook delivery view

View one webhook delivery.

Usage

polymorfa webhook delivery view DELIVERY [flags]

Arguments

  • DELIVERYrequired

    Delivery ID.

Flags

Also accepts the global flags.

polymorfa webhook list

List webhooks for an explicit resource owner.

Usage

polymorfa webhook list [flags]

Flags

  • --cursor <value>takes a value

    Continue from this opaque cursor.

  • --limit <value>takes a value

    Request this many resources per page.

    Default 25
  • --max-items <value>takes a value

    Stop automatic pagination after this many resources.

  • --paginateboolean

    Request consecutive pages until --max-items resources are collected or no pages remain. Requires --max-items.

Also accepts the global flags.

polymorfa webhook secret rotate

Rotate a webhook signing secret.

Usage

polymorfa webhook secret rotate WEBHOOK [flags]

Arguments

  • WEBHOOKrequired

    Webhook ID.

Flags

  • --idempotency-key <value>takes a value

    Use this key to identify retries; one is generated when omitted.

  • --overlap <value>takes a value

    Keep the previous secret valid for this duration.

  • --secret-out <value>takes a value

    Write the one-time signing secret to a new mode-0600 file.

  • --yesboolean

    Confirm the external effect without prompting.

Also accepts the global flags.

polymorfa webhook test

Create a durable synthetic webhook delivery.

Usage

polymorfa webhook test WEBHOOK [flags]

Arguments

  • WEBHOOKrequired

    Webhook ID.

Flags

  • --event <value>takes a valuerequired

    Synthetic event type.

  • --idempotency-key <value>takes a value

    Use this key to identify retries; one is generated when omitted.

  • --input <value>takes a value

    Read optional test input from a file or stdin (-). Project tests accept body and sessionId together; team tests accept only eventType.

Also accepts the global flags.

polymorfa webhook update

Update a webhook without rotating its secret.

Usage

polymorfa webhook update WEBHOOK [flags]

Arguments

  • WEBHOOKrequired

    Webhook ID.

Flags

  • --idempotency-key <value>takes a value

    Use this key to identify retries; one is generated when omitted.

  • --input <value>takes a value

    Read the webhook update JSON object from a file or stdin (-). Optional with --phone-offline-start-day.

  • --phone-offline-start-day <value>takes a value

    First day without the phone on which the webhook receives session.phone_offline (7-13), or off to remove that event. WhatsApp signs the device out on day 14.

Also accepts the global flags.

polymorfa webhook view

View one webhook.

Usage

polymorfa webhook view WEBHOOK [flags]

Arguments

  • WEBHOOKrequired

    Webhook ID.

Flags

Also accepts the global flags.