Valley

Webhooks

PATCH /public/v1/webhooks/{id}

Update a webhook. Only the fields you send are changed. triggerTypes replaces the full list. enabled=false pauses delivery without deleting the webhook; enabled=true resumes it. WORKSPACE webhooks require ADMIN/OWNER.

PATCH /public/v1/webhooks/{id}

PATCH /public/v1/webhooks/{id}

curl --request PATCH \
  --url 'https://api.joinvalley.co/public/v1/webhooks/{ID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "value"
}'
{
  "statusCode": 1,
  "status": true,
  "message": "<string>",
  "data": {
    "webhook": {
      "id": "<string>",
      "label": null,
      "scope": "PERSONAL",
      "webhookUrl": "<string>",
      "triggerTypes": [
        "<string>"
      ],
      "payloadFields": null,
      "isActive": true,
      "createdByUserId": "<string>",
      "workspaceId": null,
      "createdAt": "<string>",
      "lastUsedAt": null
    }
  }
}

Default Response

Authorizations

  • x-api-key string required header

    Your Valley API key.

Path Parameters

  • id string required

Request Body

application/json
  • label string
  • webhookUrl string

    New absolute http(s) endpoint.

  • triggerTypes[] string enum arrayenum

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

  • payloadFields object | null

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

    + Show Child Attributes
    • include_icp_fit boolean
    • include_icp_fit_justification boolean
    • include_template_name boolean
    • include_subject boolean
    • include_message_type boolean
    • include_message_index boolean
    • include_file_upload_data boolean
    • first_prospect_response_inmail_only boolean
    • warm_list_min_icp_fit string enum enum

      Allowed values: HIGH, MEDIUM, LOW.

  • enabled boolean

    false pauses delivery, true resumes it.

Response

application/json
  • statusCode number
  • status boolean
  • message string
  • data object
    + Show Child Attributes
    • webhook object
      + Show Child Attributes
      • id string
      • label null | string
      • scope string enum enum

        Allowed values: PERSONAL, WORKSPACE.

      • webhookUrl string
      • triggerTypes[] string array
      • payloadFields null | object
        + Show Child Attributes
        • [key: string] any additional

          Additional arbitrary properties are allowed.

      • isActive boolean

        false = paused; nothing is delivered until re-enabled.

      • createdByUserId string
      • workspaceId null | string
      • createdAt string
      • lastUsedAt null | string