Virlo webhook integration reference

What to build with it

Use an HTTPS receiver and implement the documented signature verification before processing events.
Deduplicate event IDs and acknowledge safely before triggering expensive downstream work.
Inspect delivery history before retrying or re-enabling an endpoint.

Provider reference: Virlo documentation. Authentication uses a provider-issued Bearer token, stored on your server.

Endpoints and inputs

9 documented operations. Query and path fields are listed separately from JSON request-body fields.

POST/v1/webhooks

No path or query parameters are declared in the captured schema.

JSON body fields

url: string · required
description: string · optional
enabled_events: array · required
headers: object · optional
is_active: boolean · optional · default: true

Documented response fields

id: string · required
team_id: string · required
url: string · required
description: string | null · optional
enabled_events: array · required
headers: object · optional
is_active: boolean · required
status: string · required · values: active, inactive, disabled_by_system
consecutive_failures: number · required
last_success_at: string | null · optional
last_failure_at: string | null · optional
created_by: string | null · optional
created_at: string · required
updated_at: string · required

Documented HTTP responses: 201, 400, 401, 409, 429. Handle each non-success response explicitly; do not silently convert a failed lookup to an empty result.

GET/v1/webhooks

No path or query parameters are declared in the captured schema.

The captured schema does not enumerate structured response fields for this operation. Check its current provider reference.

Documented HTTP responses: 200, 401, 429. Handle each non-success response explicitly; do not silently convert a failed lookup to an empty result.

GET/v1/webhooks/{id}

Path and query parameters

id: string (path) · required

Documented response fields

id: string · required
team_id: string · required
url: string · required
description: string | null · optional
enabled_events: array · required
headers: object · optional
is_active: boolean · required
status: string · required · values: active, inactive, disabled_by_system
consecutive_failures: number · required
last_success_at: string | null · optional
last_failure_at: string | null · optional
created_by: string | null · optional
created_at: string · required
updated_at: string · required

Documented HTTP responses: 200, 401, 404, 429. Handle each non-success response explicitly; do not silently convert a failed lookup to an empty result.

PATCH/v1/webhooks/{id}

Path and query parameters

id: string (path) · required

JSON body fields

url: string · optional
description: string · optional
enabled_events: array · optional
headers: object · optional
is_active: boolean · optional

Documented response fields

id: string · required
team_id: string · required
url: string · required
description: string | null · optional
enabled_events: array · required
headers: object · optional
is_active: boolean · required
status: string · required · values: active, inactive, disabled_by_system
consecutive_failures: number · required
last_success_at: string | null · optional
last_failure_at: string | null · optional
created_by: string | null · optional
created_at: string · required
updated_at: string · required

Documented HTTP responses: 200, 401, 404, 429. Handle each non-success response explicitly; do not silently convert a failed lookup to an empty result.

DELETE/v1/webhooks/{id}

Path and query parameters

id: string (path) · required

The captured schema does not enumerate structured response fields for this operation. Check its current provider reference.

Documented HTTP responses: 204, 401, 404, 429. Handle each non-success response explicitly; do not silently convert a failed lookup to an empty result.

POST/v1/webhooks/{id}/reenable

Path and query parameters

id: string (path) · required

Documented response fields

id: string · required
team_id: string · required
url: string · required
description: string | null · optional
enabled_events: array · required
headers: object · optional
is_active: boolean · required
status: string · required · values: active, inactive, disabled_by_system
consecutive_failures: number · required
last_success_at: string | null · optional
last_failure_at: string | null · optional
created_by: string | null · optional
created_at: string · required
updated_at: string · required

Documented HTTP responses: 200, 401, 404, 429. Handle each non-success response explicitly; do not silently convert a failed lookup to an empty result.

POST/v1/webhooks/{id}/test

Path and query parameters

id: string (path) · required

JSON body fields

event_type: string · optional · values: content_research_agent.run.completed, content_research_agent.event.detected, comet.run.completed, orbit.run.completed, satellite.lookup.completed, trends.daily.completed, trends.region.completed, tracking.cycle.completed, tracking.outlier_video.detected, tracking.paused, audience.snapshot.completed

Documented response fields

delivery_id: string · required
event_type: string · required

Documented HTTP responses: 202, 401, 404, 429. Handle each non-success response explicitly; do not silently convert a failed lookup to an empty result.

GET/v1/webhooks/{id}/deliveries

Path and query parameters

id: string (path) · required
cursor: string (query) · optional
limit: number (query) · optional
event_type: string (query) · optional
status: string (query) · optional · values: pending, delivering, succeeded, failed, dead

Documented response fields

endpoint_id: string · required
deliveries: array · required
deliveries[].id: string · required
deliveries[].endpoint_id: string · required
deliveries[].team_id: string | null · optional
deliveries[].event_type: string · required
deliveries[].source_run_id: string | null · optional
deliveries[].source_table: string | null · optional
deliveries[].payload: object · optional
deliveries[].payload_size_bytes: number · optional
deliveries[].status: string · required · values: pending, delivering, succeeded, failed, dead
deliveries[].attempt_count: number · required
deliveries[].max_attempts: number · required
deliveries[].next_attempt_at: string | null · optional
deliveries[].last_http_status: number | null · optional
deliveries[].last_error: string | null · optional
deliveries[].created_at: string · required
deliveries[].updated_at: string | null · optional
limit: number · required
next_cursor: string | null · optional

Documented HTTP responses: 200, 401, 404, 429. Handle each non-success response explicitly; do not silently convert a failed lookup to an empty result.

POST/v1/webhooks/deliveries/{deliveryId}/retry

Path and query parameters

deliveryId: string (path) · required

Documented response fields

queued: boolean · required

Documented HTTP responses: 202, 400, 401, 404, 429. Handle each non-success response explicitly; do not silently convert a failed lookup to an empty result.

Before you integrate

Treat webhook delivery as retryable and potentially duplicated. A test event does not prove a complete paid lookup has finished.

Check the provider's current price, allowed use and retention terms before sending requests. An optional field can be absent; the schema alone does not establish its completeness or accuracy.

Give this task to your coding agent

virlo-webhooks agent prompt

Help me implement virlo webhook integration reference using the documented Virlo API.

Reference: https://allthemapis.com/social-media-apis/virlo-webhooks
Provider documentation: https://dev.virlo.ai/docs/webhooks
Base URL: https://api.virlo.ai
Starting operation: POST /v1/webhooks

Read the current provider docs and confirm the required inputs before writing code. Load VIRLO_API_KEY from a server-side environment variable and use Bearer authentication. Do not put the key in client code, logs, analytics, or the chat.

Ask me for any missing video URL, creator handle, research intent, or job ID. Do not invent a result. Ask for approval before starting billable lookups, recurring jobs, or destructive changes. For jobs, keep the returned ID and poll with the documented delay instead of starting the job twice. Handle pagination, rate limits, partial results, and missing fields explicitly.

Build the smallest integration for this task:
1. Use an HTTPS receiver and implement the documented signature verification before processing events.
2. Deduplicate event IDs and acknowledge safely before triggering expensive downstream work.
3. Inspect delivery history before retrying or re-enabling an endpoint.

Return the code, the environment variables I need, and a short explanation of what was actually retrieved versus inferred. Do not execute paid requests until I approve.

Sources and review dates

Virlo's public documentation and OpenAPI schema reviewed October 27, 2026. Endpoint paths and field names below refer to that provider's API. This is an integration reference, not a measured performance ranking.

Corrections: email faizank@docsalot.dev with an official source.

What to build with it

Endpoints and inputs

JSON body fields

Documented response fields

Path and query parameters

Documented response fields

Path and query parameters

JSON body fields

Documented response fields

Path and query parameters

Path and query parameters

Documented response fields

Path and query parameters

JSON body fields

Documented response fields

Path and query parameters

Documented response fields

Path and query parameters

Documented response fields

Before you integrate

Give this task to your coding agent

Sources and review dates

Explore social media APIs

Get the next API benchmark.