Skip to contents

Create a webhook on a Monday board

monday_create_webhook.Rd

Registers a webhook so Monday POSTs to url whenever event occurs on the board. On creation Monday immediately sends a one-time challenge POST to url, which the receiving endpoint must echo back.

Usage

monday_create_webhook(
  board_id,
  url,
  event,
  config = NULL,
  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.

event

Character scalar. A Monday WebhookEventType, e.g. "change_column_value", "create_item", or "delete_pulse".

config

Optional named list passed as the webhook config JSON (e.g. list(columnId = "status") for column-specific events). NULL by default.

api_key

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

Value

A one-row tibble with the new webhook id and board_id.

See also

monday_list_webhooks(), monday_delete_webhook()