VictoriaAI
View as Markdown

List a campaign's webhooks

GET/v1/campaigns/{campaign_id}/webhooks
Scope: campaigns:read

Every webhook registered on the campaign, enabled and disabled. Signing secrets are never returned.

Headers

  • AuthorizationstringRequired

    Bearer followed by a space and your API key, for example Bearer vk_….

Path parameters

  • campaign_idstring · uuidRequired

    ID of the campaign.

Query parameters

  • limitinteger

    Maximum rows to return

    ≥ 1≤ 500Default 100
  • offsetinteger

    Rows to skip before returning results

    ≥ 0Default 0

Response

200

  • totalintegerRequired

    Total rows matching the query, across all pages

  • limitintegerRequired

    Page size that was applied

  • offsetintegerRequired

    Rows skipped before this page

  • has_morebooleanRequired

    Whether a further page exists

  • webhooksarray of objectsRequired

    List of webhook subscriptions for the campaign

    Show 5 child attributes
    • idstringRequired

      Webhook subscription ID

      Example "550e8400-e29b-41d4-a716-446655440000"
    • webhook_urlstringRequired

      URL that receives webhook events

      Example "https://api.example.com/webhooks/victoria"
    • is_enabledbooleanRequired

      Whether this webhook is currently active

      Example true
    • created_atstringRequired

      When this webhook was created

      Example "2024-01-15T10:30:00+00:00"
    • updated_atstring or null

      When this webhook was last updated

      Example "2024-01-20T14:45:00+00:00"
  • countintegerRequired

    Webhooks in this page. Deprecated: use total

  • successboolean
    Default true

Errors

Errors share one JSON body: success, error, message, optional details, and request_id.

StatusCodeMeaning
400VALIDATION_ERROR

The request didn't match the endpoint's schema: a missing or malformed field, a bad query parameter, or a value out of range. details.errors lists each failing field with its field, message and type.

401UNAUTHORIZED

The Authorization header is missing or malformed, or the API key is unknown or has been deactivated.

401API_KEY_EXPIRED

The API key is past its expiry date. Create a new key in the Victoria AI app.

403INSUFFICIENT_SCOPE

The API key doesn't have the scope this endpoint requires, such as leads:write.

403ORGANIZATION_DEACTIVATED

The organization that owns this API key has been deactivated.

404CAMPAIGN_NOT_FOUND

No campaign with this ID exists in your organization.

404NOT_FOUND

No endpoint matches the path. A resource ID in the path that isn't a valid UUID also answers NOT_FOUND.

429RATE_LIMITED

Too many requests for this API key: more than 100 a minute to one endpoint, or 600 a minute in total. Retry after the number of seconds in the Retry-After header. See Rate limits.

500INTERNAL_ERROR

Something failed on our side. The response never includes internal details; quote its request_id when you contact support.

503UPSTREAM_TIMEOUT

A service the API depends on timed out. The request is safe to retry.

503AUTH_UNAVAILABLE

The API key couldn't be checked because the authentication service was unavailable. The request is safe to retry.

Response headers

HeaderDescription
X-Request-ID

Correlation ID for the request, also returned as request_id in error bodies. Send your own X-Request-ID, up to 128 letters, digits, ., _, : or -, and it's used instead.

RateLimit-Limit

Requests allowed to this endpoint per minute.

RateLimit-Remaining

Requests you can still send to this endpoint right now.

RateLimit-Reset

Seconds until the endpoint's full limit is available again.

Retry-After

On a 429: seconds to wait before retrying.