Poll Webhook Result

Endpoint essentials
API key accessapi/v1/webhook_result/show or Master API key
OAuth scopeswebhook_result_read
Credit usage0 credits
Learn more about API pricing and credits.

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, bulk people enrichment, or validate email addresses and phone numbers 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 (404—the request_id is not recognized, usually because it was mistyped or never issued), request_id_expired (410—the result has aged out past the 30-day window, so start a fresh enrichment request), and invalid_request_id (400—the request_id is not a valid signed 64-bit integer).

For requests made with poll_only set to true, webhook_status is skipped, because Apollo doesn't send a webhook.

Path Params
string
required
^-?[0-9]+$

For people enrichment and bulk people enrichment, pass the top-level request_id_str only when phone_enrichment.status is pending. Do not pass phone_enrichment.request_id. The value is a signed 64-bit integer represented as a string and can be positive or negative.

Example: -9045486258674686251

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain