Valley

Webhooks

GET /public/v1/webhooks

List outbound webhooks visible to the caller: their own PERSONAL webhooks plus every WORKSPACE-scoped one. Paused webhooks are included with isActive=false. Optionally scoped to one workspace.

GET /public/v1/webhooks

GET /public/v1/webhooks

curl --request GET \
  --url 'https://api.joinvalley.co/public/v1/webhooks' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "statusCode": 1,
  "status": true,
  "message": "<string>",
  "data": {
    "webhooks": [
      {
        "id": "<string>",
        "label": null,
        "scope": "PERSONAL",
        "webhookUrl": "<string>",
        "triggerTypes": [],
        "payloadFields": null,
        "isActive": true,
        "createdByUserId": "<string>",
        "workspaceId": null,
        "createdAt": "<string>",
        "lastUsedAt": null
      }
    ],
    "pagination": {
      "limit": 1,
      "offset": 1,
      "total": 1,
      "hasMore": true
    }
  }
}

Default Response

Authorizations

  • x-api-key string required header

    Your Valley API key.

Query Parameters

  • limit number
  • offset number
  • workspaceId string

    Restrict to one workspace (membership validated). A workspace API key is always locked to its own workspace.

Response

application/json
  • statusCode number
  • status boolean
  • message string
  • data object
    + Show Child Attributes
    • webhooks[] object array
      + 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
    • pagination object
      + Show Child Attributes
      • limit number
      • offset number
      • total number
      • hasMore boolean