MsgCoreInstall

Summary

Create a new webhook for event notifications

Inputs

• name (required) — Friendly name for the webhook. Populates the request body field 'name'.
• url (required) — Target URL for webhook delivery. Populates the request body field 'url'.
• events (required) — Comma-separated list of events to subscribe to (message.received, message.sent, message.failed, button.clicked, reaction.added, reaction.removed). Populates the request body field 'events'.
• project (required) — Project identifier to operate on. Used in the URL path as /api/v1/projects/{{project}}/webhooks. Defaults to 'default'.
• secret — Custom webhook secret. If not provided, one is auto-generated. Populates the additionalFields body field 'secret'.

Output shape

The API returns the created webhook configuration object. Exact return shape not explicitly documented in the provided properties or source; follow the MsgCore API response format for webhook creation.

Both properties and source agree on the POST method, URL pattern, and required body fields. The project parameter is used in the URL path (confirmed by source) rather than the request body, despite being listed as a property with a default value.

Examples

Example 1: Basic webhook creation

Set name, url, and events; leave project at default and omit secret for auto-generation.

Example 2: Batched webhook sync

Configure requestOptions with batching (batchSize: 50, batchInterval: 1000) to throttle deliveries.