RErelaw
Webhooks

Subscribe a webhook

Registers an HTTPS URL to receive events. The same endpoints a firm adds in Settings → API & Webhooks, exposed so Zapier (and any other REST Hook client) can subscribe when a Zap turns on.

Idempotent on (firm, url, events): a retried subscribe returns the existing row rather than creating a second delivery target.

The signing secret is returned only when a row is created. A read-only key is enough — asking to be notified is not a write.

post/api/v1/webhooks

Request

  • Base URL
    https://app.relaw.ai
  • URL
    https://app.relaw.ai/api/v1/webhooks
  • Auth
    HTTP bearer

Request body

urlstring uri required

HTTPS only. hookUrl is accepted as an alias.

hookUrlstring uri

Alias for url.

eventsstring[]

Empty or omitted means every event. Unknown names are dropped.

descriptionstring

Shown in Settings. e.g. 'Zapier: New Lead'.

Response

An identical subscription already existed.

idstring uuid required
object'webhook' required
urlstring uri required
eventsstring[] required

Empty means every event type.

descriptionstring nullable
createdAtstring date-time
secretstring

Present only on create, never on a reused subscription. HMAC key for relaw-signature.

Changes

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