POST /public/v1/webhooks – Joinvalley Valley Public API

Webhooks

Register an outbound webhook. Valley POSTs a JSON payload to webhookUrl whenever one of the triggerTypes fires. scope PERSONAL (default) fires only for the caller's own events; WORKSPACE fires for every member and requires ADMIN/OWNER.

post/public/v1/webhooks

Request body

workspaceIdstring

Required for a user API key. A workspace API key is locked to its own workspace.

webhookUrlstring required

Absolute http(s) endpoint Valley will POST event payloads to.

triggerTypesstring[] required

Events that fire this webhook. PROSPECT_RESPONSE and SEND_FIRST_PROSPECT_RESPONSE are mutually exclusive; if both are sent only PROSPECT_RESPONSE is kept.

scope'PERSONAL' | 'WORKSPACE'

labelstring

Response

Default Response

statusCodenumber

statusboolean

messagestring

Changes

Changed in 2 of the 7 revisions of this API.2

Oct 6, 202616d733866b5a1See the full diff
- ○
  added the new ADDED_TO_DNC enum value to the request property /
  request-property-enum-value-added
Sep 9, 20268997574763c01See the full diff
- ○
  endpoint added
  endpoint-added

Full history