Skip to contents

Ensure a set of webhook events exist on a Monday board

monday_ensure_webhooks.Rd

Idempotently registers events pointing at url for one board: existing webhooks that already match the same url + event are left untouched, and only the missing ones are created. Safe to re-run.

Usage

monday_ensure_webhooks(
  board_id,
  url,
  events = c("create_item", "change_column_value", "item_deleted"),
  api_key = Sys.getenv("MONDAY_API_KEY")
)

Arguments

board_id

Character or numeric. The Monday board id.

url

Character scalar. The HTTPS endpoint Monday should POST to.

events

Character vector of WebhookEventType values to ensure. Defaults to the events that keep a calendar in sync.

api_key

Character scalar. Monday API key. Defaults to Sys.getenv("MONDAY_API_KEY").

Value

A tibble of the webhooks that were newly created (zero rows if all already existed).

Details

Monday does not expose the target url in its webhooks query response, so "already exists" is matched on event alone. If you point a board's events at a new url, delete the old webhooks first with monday_delete_webhook().

See also

monday_list_webhooks(), monday_create_webhook()