Apollo: Poll Webhook Result

Recovering a completed Apollo phone or waterfall result by its request ID when the webhook callback was not received.

Tool ID: apollo_poll_webhook_result

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'apollo_poll_webhook_result',
  {
    "request_id": 1
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute apollo_poll_webhook_result --input '{
  "request_id": 1
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "request_id": "request_123",
    "webhook_status": "in_progress",
    "request_type": "email"
  }
}

Use deepline describe apollo_poll_webhook_result --json for the latest machine-readable contract.

Input reference

Endpoint essentials API key access: `api/v1/webhook_result/show` or `Master API key` OAuth scopes: `webhook_result_read` Use the Poll Webhook Result endpoint to retrieve webhook results from Apollo. This endpoint enables you to poll for the webhook payload if you didn’t receive the original webhook callback. To use this endpoint, you need the request_id from the People Enrichment or Bulk People Enrichment endpoint. Pass this value as request_id in this endpoint. This endpoint returns webhook results for your team from up to thirty days after the webhook was triggered. While an enrichment is still processing, this endpoint returns a 404 with error_code: result_pending and a retry_after_seconds value—wait that many seconds and poll again. Once the result is ready, it returns a 200 . Three responses are terminal, so stop polling if you receive any of them: request_id_unknown ( See the live schema below for the complete notes.

Name	Type	Required	Default	Details
`payload.request_id`	`union`	Yes	—	The request_id returned when the original enrichment request was submitted. This value is a signed 64-bit integer and can be positive or negative. Example: 1039995589705121900

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.request_id`	`string`	No	—	Echoes the request_id from the URL.
`result.data.webhook_status`	`"in_progress" \| "success" \| "failed"`	No	—	The current webhook status. Allowed: `in_progress`, `success`, `failed`.
`result.data.request_type`	`"email" \| "phone" \| "waterfall"`	No	—	The enrichment request type. Allowed: `email`, `phone`, `waterfall`.
`result.data.last_dispatched_at`	`string \| null`	No	—	ISO 8601 UTC timestamp of the last webhook POST attempt. Returns null until Apollo makes the first dispatch attempt.
`result.data.failure_reason`	`string \| null`	No	—	The error message from the last failed dispatch. This field is populated when webhook_status is failed .
`result.data.webhook_result`	`object \| null`	No	—	The original webhook payload that Apollo delivered, or would have delivered, to the customer webhook URL. The shape varies by request_type .
`result.data.request_id_exact`	`string`	No	—	Authoritative exact decimal request ID. Pass this string as request_id to apollo_poll_webhook_result. The legacy numeric field can be rounded.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation