webhooks

Create Webhook

post/api/v1/webhooks

Request

  • Base URL: https://api.billcommons.org
  • URL: https://api.billcommons.org/api/v1/webhooks
  • Auth: none declared

Request body

urlstring required
emailstring required
kindstring required

topic | jurisdiction | bills

targetstring required

topic: a topic slug. jurisdiction: a jurisdiction abbreviation. bills: comma-separated bill UUIDs (at most 64, and the combined url/kind/target/event_kinds must fit a shared byte budget -- see docs/api/webhooks.md).

jurisdictionstring nullable

Only used with kind='topic', to scope the topic to one state, e.g. 'FL'.

event_kindsstring nullable

Comma-separated subset of created,status,actions,sponsors,text,metadata,votes. Omit for all kinds.

Response

Successful Response

idstring uuid required
manage_tokenstring required

Shown once. Bearer token for GET/DELETE/reactivate -- store it now.

signing_secretstring required

HMAC key for verifying delivery signatures.

verifiedboolean required
notestring required

Changes

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