Register a webhook on a scraper
Registers a URL that Emelia calls when this scraper finishes or stops on an error. Register it right after creating the scraper. Several URLs can be registered on the same scraper; the same URL cannot be added twice.
What is sent: a POST with a JSON body { "event", "id", "name", "error" } (see ScrapperWebhookEvent). FINISHED is sent when the extraction ends (status done, all chunks included). ERROR is sent when the scraper stops with an error code, at most once per hour for the same scraper and code.
Current behavior to know: every registered URL receives every event, whatever its events list; ERROR is only sent if at least one registered URL asked for ERROR. One attempt only: no retry, no signature, no custom header, so check the scraper with GET /linkedin-scrappers/{id} when you receive a call. Nothing is sent at the end of an enrichment.
events must contain FINISHED or ERROR; other values are accepted and ignored.
Known issue: the success response is currently an empty JSON object {} (no success field). Treat HTTP 200 as success.
Request
- Base URL: https://api.emelia.io
- URL: https://api.emelia.io/linkedin-scrappers/{id}/webhook
- Auth: API key in header Authorization
Path parameters
Scrapper id (_id returned by POST /linkedin-scrappers or GET /linkedin-scrappers). 24 hexadecimal characters.
Request body
Response
Registered. Current body: {}.
Current behavior of the webhook routes: an empty object. Treat HTTP 200 as success.
Changes
No recorded changes to this operation across all 1 revision of this API.