Lettr icon

Lettr

Interact with Lettr transactional email APIs

Webhook → Create

AI-generated

Summary

Create a Lettr webhook that sends events to a target URL, optionally using Basic or OAuth2 authentication. Subscribe to all events or choose specific engagement, generation, message, relay, and unsubscribe event types.

Inputs

  • Name (required) — Webhook name.
  • Target URL (required) — URL where Lettr will send webhook events.
  • Auth Type — Choose None (default), Basic, or OAuth2. Basic requires an auth username and password; OAuth2 requires a client ID, client secret, and token URL.
  • Events Mode — Choose All Events (default) or Selected Events. Selected Events uses the Events field to specify subscriptions.
  • Events — Event types to subscribe to when Events Mode is Selected Events. Options cover engagement, generation, message, relay, and unsubscribe events.

Output shape

a single record

The provided source pack shows only a signature-level outline, so it does not reveal the API request details or exact response shape.

Examples

Example 1: Subscribe to selected events

Provide a name and target URL, choose an auth type and its required credentials if applicable, set Events Mode to Selected Events, and select one or more event types.

Example 2: Subscribe to every event

Provide a name and target URL, configure optional authentication, and leave Events Mode set to All Events.

Links

Discussion