Create & Manage Webhooks

​

Adding a Webhook

1. Open one of your Runs and navigate to the Webhooks tab.

2. Click Add Webhook to access a modal with available options.

3. Choose one of three event types:
   • Created: Triggered when a job starts and the first task launches.
   • Succeeded: Triggered when a job completes successfully.
     {
       "uid": "eaab7f39...",
       "job_uid": "b9a260de...",
       "message": "Job successfully finished.",
       "project_uid": "xxxxx...",
       "error": null,
       "recipe_ref": "b9a260de...",
       "workflow_uid": "edcee5c...",
       "workflow_name": "Extract LinkedIn Messages",
       "job_name": "Automated Run"
     }
     
   • Failed: Triggered when a job encounters an error.
     {
       "uid": "a8e9923c...",
       "job_uid": "88f0a5fb...",
       "message": "Job failed.",
       "project_uid": "xxxxx...",
       "error": "Error while completing action: cannot re-send connection request yet.",
       "recipe_ref": "88f0a5fb...",
       "workflow_uid": "edcee5c...",
       "workflow_name": "Connect LinkedIn Profile",
       "job_name": "Campaign connect with Leads"
     }
     
4. Once created, your webhook will be ready to use.

​

Headers Configuration

• Header Name: Specify the key (e.g., Authorization, Content-Type).
• Header Value: Provide the value (e.g., Bearer token, application/json).

​

Webhook Payload

{
  "uid": "The webhook UID",
  "job_uid": "The job UID the webhook has been triggered on.",
  "message": "Default message based on failure or success.",
  "project_uid": "Your project UID. Useful to integrate our API.",
  "error": "If there's an error, this key contains the error message."
}

​

Handling Job Results: Success vs. Failed Inputs

• Failed Status: Triggered if all inputs fail.
• Succeeded Status: Triggered if at least one input succeeds, even if others fail.

• API Reference: Get a Run’s Inputs
• Endpoint: https://api.captaindata.co/v3/jobs/{job_uid}/inputs

​

Common Reasons for Failed Inputs

• 404 Errors: The profile or resource is inaccessible.
• Incorrect Inputs: Invalid or improperly formatted inputs.
• Authentication Issues: For example, an invalid LinkedIn session cookie.

{
  "uid": "80149f56-a0e9-4b18-...",
  "job_uid": "92681a73-be6d-4114-..",
  "message": "Job failed.",
  "project_uid": "xxxxxxx-e8b3-445c-...",
  "error": "Your cookie is not valid. Update your LinkedIn integration's account by clicking on the refresh button if you have installed the extension or update it manually.",
  "recipe_ref": "xxxxxxx-be6d-4114-97d4-...",
  "workflow_uid": "dac53683-dc50-...",
  "workflow_name": "Extract LinkedIn People Profile",
  "job_name": "test invalid cookie"
}

​

Retrying Failed Inputs

• Do Not Retry: Issues like 404 errors or incorrect inputs.
• Retry Possible: Temporary issues such as API timeouts or invalid session cookies.

1. Refresh and resume paused jobs.
2. Update your cookie or resolve the issue and retry. Retry a Run Guide

​

Retrying a Webhook

• Testing: Re-trigger to validate the integration.
• Missed Webhooks: Reattempt delivery if the webhook wasn’t triggered.

​

Using the API

curl --request POST \
--url https://api.captaindata.co/v3/webhooks/{job_uid}/retry \
--header 'Authorization: <api-key>' \
--header 'x-project-id: <api-key>'

​

Retrying in the UI

1. Open the specific job by its UID.
2. Navigate to the Webhooks tab.
3. Click Retry and paste the job UID to reattempt delivery.