Create a webhook subscription
lob_webhooks_createSet up a webhook to monitor mail delivery events by registering an HTTPS URL and selecting event types.
Instructions
Subscribe an HTTPS endpoint to receive Lob event notifications (e.g. 'postcard.mailed', 'letter.in_transit', 'check.delivered'). The endpoint must respond with 2xx within 5 seconds.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | HTTPS URL to receive event POSTs. | |
| extra | No | Additional Lob API parameters not enumerated above. Merged into the request body verbatim. See https://docs.lob.com for the full parameter list per resource. | |
| metadata | No | Up to 20 string key/value pairs of arbitrary metadata to attach to the resource. | |
| description | No | ||
| event_types | Yes | Event types to subscribe to, e.g. ['postcard.mailed', 'letter.delivered']. Use ['*'] for all. |