webhooks

Subscribe a webhook to a list's changes

Registers an https endpoint that receives a JSON POST whenever the list's content changes (events: added, removed, edited, sorted, renamed, deleted). The list must be visible to the connected account. Deliveries carry X-ListDrop-Event and X-ListDrop-Signature: sha256=<hex HMAC-SHA256 of the raw body> using the per-hook secret returned ONCE here. Ten consecutive failures disable the hook. Caps: 3 hooks per list, 20 per account.

post/api/v1/lists/{id}/webhooks

Request

  • Base URL: https://www.listdrop.co
  • URL: https://www.listdrop.co/api/v1/lists/{id}/webhooks
  • Auth: OAuth 2 (authorization code, authorization URL https://www.listdrop.co/oauth/authorize, token URL https://www.listdrop.co/api/oauth/token, scopes: lists:read)

Path parameters

idstring required

The list id, the segment after /l/ in any ListDrop list URL.

Request body

urlstring uri required

https endpoint to POST deliveries to.

Response

Registered. The secret appears only in this response.

idstring required
listIdstring required
urlstring uri required
secretstring required

HMAC-SHA256 signing secret (whsec_…). Shown exactly once — store it now.

messagestring required

Changes

No recorded changes to this operation across all 1 revision of this API.