Navigation

Fetch Webhooks

Retrieve all webhook configurations for your organization

POST /public/account/fetchWebhooks

Returns all webhook configurations registered for the authenticated user's organization. Includes endpoint URLs, subscribed events, authentication type, timeout, retry settings, last trigger timestamp, last delivery status, failure count, and overall status.

Requires a valid `api_key` in the JSON request body

Tip: Send `{"help": true}` as the request body to receive full usage documentation and a sample response directly from the endpoint.

Parameters

Name In Type Required Description
api_key body string Yes Your Zyntro API key
org_id body string Yes Your organization UUID

Request Body

Content-Type: application/json

Example

json
{
    "org_id": "YOUR_ORG_ID",
    "api_key": "YOUR_API_KEY"
}

Code Samples

bash
curl -X POST https://app.zyntrohq.com/public/account/fetchWebhooks \
  -H "Content-Type: application/json" \
  -d '{"api_key": "YOUR_API_KEY", "org_id": "YOUR_ORG_ID"}'

Response

200 Webhooks retrieved
json
{
    "data": [
        {
            "wh_id": "d4e5f6a7-b8c9-0123-defg-456789012345",
            "wh_name": "CRM Sync Webhook",
            "wh_events": [
                "new_contact",
                "form_filled",
                "invoice_paid"
            ],
            "wh_status": "active",
            "wh_timeout": 30,
            "wh_endpoint": "https://example.com/zyntro-webhook",
            "wh_auth_type": "bearer",
            "wh_created_at": "2026-03-13 13:40:11",
            "wh_updated_at": "2026-04-02 15:59:37",
            "wh_last_status": "success",
            "wh_retry_count": 3,
            "wh_retry_delay": 60,
            "wh_failure_count": 0,
            "wh_last_triggered": "2026-04-02 15:59:37"
        }
    ],
    "status": "success"
}
200 No webhooks
json
{
    "data": [],
    "status": "success"
}
Info: Monitor webhook health using `wh_last_status` and `wh_failure_count`. A high failure count with a `failed` last status indicates your endpoint may be unreachable or returning errors. Zyntro retries failed deliveries based on `wh_retry_count` and `wh_retry_delay` settings.

Errors

Code Message Resolution
MISSING_API_KEY Missing API Key
The api_key is missing.
Include your API key.
INVALID_API_KEY Invalid API Key
No active user matches.
Verify your key.
MISSING_ORG Missing org ID
The org_id is missing.
Include your org ID.

Was this article helpful?

NotebookLM Overviews