POST /public/v1/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

API key in header x-api-key

curl --request POST \
  --url 'https://api.joinvalley.co/public/v1/webhooks' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "value"
}'

{
  "statusCode": 1,
  "status": true,
  "message": "example",
  "data": {
    "webhook": {
      "id": "id_01JXY9AZK4KV",
      "label": "example",
      "scope": "PERSONAL",
      "webhookUrl": "https://example.com/webhook",
      "triggerTypes": [
        "example"
      ],
      "payloadFields": "example",
      "isActive": true,
      "createdByUserId": "created_by_user_01JXY9AZK4KV",
      "workspaceId": "workspace_01JXY9AZK4KV",
      "createdAt": "2026-01-01T12:00:00Z",
      "lastUsedAt": "2026-01-01T12:00:00Z"
    }
  }
}

Default Response

Body

required application/json

workspaceId string

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

webhookUrl string · min length: 1 required

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

triggerTypes array of string · min items: 1· unique items 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.

values

PROSPECT_RESPONSE
SEND_FIRST_PROSPECT_RESPONSE
CONNECTION_ACCEPTED
SEND_INTERESTED_RESPONSES
SEND_MIGHT_BE_INTERESTED_RESPONSES
SEND_NOT_INTERESTED_RESPONSES

scope string · default: PERSONAL· enum

values

PERSONAL
WORKSPACE

label string · min length: 1· max length: 255

payloadFields object | null

Optional payload opt-ins (extra fields to include in the delivered JSON). null clears them.

Body

Responses