Incoming webhooks

With Linked Helper cloud-based storatge version, it is possible to add profiles to a campaign via incoming webhook. 

• Creating webhook
• Sending data to webhook
  • Payload schema and examples
• Deleting webhook

Creating webhook

Note: incoming webhooks available only for Linked Helper cloud-based storage version users.

• Open a campaign and navigate to Workflow tab
• Click Webhook icon next to the Add button
  
• Give it a name and click Add webhook button
  
• Once webhook is created, you can:
  • enable Stand by mode which allows you to keep campaign ready to resume when new profiles received, otherwise you will need to start it manually when profiles have been added;
  • copy webhook URL and add to your other tool:
    
  •  Add another webhook to receive profiles from different sources:
    

Sending data to webhook

Payload schema and examples

Webhook can receive POST requests with payload data in the request body:

• required: LinkedIn or Sales Navigator URLs
• optional: custom fields

It's possible to send multiple URLs in one request, each one having several custom fields (or none at all). 

Payload Schema:

{
  "type": "object",
  "required": ["people"],
  "properties": {
    "people": {
      "type": "array",
      "minItems": 1,
      "items": {
        "type": "object",
        "required": ["externalId"],
        "properties": {
          "externalId": {
            "type": "string",
            "minLength": 1,
            "format": "uri",
            "description": "LI/SN profile URL. Backend extracts person external id from the link."
          },
          "customFields": {
            "type": "array",
            "minItems": 1,
            "items": {
              "type": "object",
              "required": ["key", "value"],
              "properties": {
                "key": {
                  "type": "string",
                  "minLength": 4,
                  "pattern": "^cs_.+"
                },
                "value": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            },
            "description": "Optional per-person custom fields."
          }
        },
        "additionalProperties": false
      },
      "description": "List of people to add to campaign."
    }
  },
  "additionalProperties": false
}

Payload Example with custom variables:

{
  "people": [
    {
      "externalId": "https://www.linkedin.com/in/jane-doe-123456789/",
      "customFields": [
        {
          "key": "cs_source",
          "value": "webhook"
        }
      ]
    },
    {
      "externalId": "https://www.linkedin.com/sales/lead/ACwAAAZXyZABcD1234567890abcdef,NAME_SEARCH,abcd1234",
      "customFields": [
        {
          "key": "cs_source",
          "value": "manual-import"
        },
        {
          "key": "cs_segment",
          "value": "enterprise"
        }
      ]
    }
  ]
}

Payload Example without custom variables:

{
  "people": [
    {
      "externalId": "https://www.linkedin.com/in/jane-doe-123456789/",
      "customFields": []
    },
    {
      "externalId": "https://www.linkedin.com/sales/lead/ACwAAAZXyZABcD1234567890abcdef,NAME_SEARCH,abcd1234",
      "customFields": []
    }
  ]
}

Deleting webhook

• Open a campaign and navigate to Workflow tab
• Click Webhook icon next to the Add button
  
• Click Bin button in the row of the webhook you'd like to delete and confirm the action: