Contacts

Add a signal to a contact

Designed for first-party signals: actions a lead takes in your own product or stack, pushed programmatically the moment they happen. Hook it to any event you already track (a lead signs up for a free trial, books a demo, attends your webinar, downloads your pricing guide, upgrades to a paid plan…) and the signal is added to the contact, next to the signals detected by Gojiberry agents, most recent first. Anything that can send an HTTP request can feed it: your backend, a CRM workflow, a form or scheduling tool webhook, Zapier, Make or n8n. The possibilities are endless.

To send a first-party signal, describe what happened in intent (e.g. “Booked a demo from the pricing page”), optionally add a short label in intentKeyword (e.g. “demo_booked”), and leave intentType empty. Signals without an intentType are recorded on every call, so repeated events (a second demo, another webinar) are all kept; make sure your integration sends each event only once.

Set intentType only to record one of the signal types detected by Gojiberry agents. A typed signal the contact already has (same intentType and intentKeyword) is not recorded twice and the call returns created: false; HIRING, HIRING_SURGE, NEW_DECISION_MAKER, RECENT_ACTIVITY, RECENTLY_CHANGED_JOB and RECENT_FUNDING_EVENT are recorded at most once per contact, whatever the keyword. At least one of intent, intentType or intentKeyword is required.

POST

https://ext.gojiberry.ai

contact

{id}

signals

Add a signal to a contact (first-party signals)

curl --request POST \
  --url https://ext.gojiberry.ai/v1/contact/{id}/signals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "intent": "Booked a demo from the pricing page",
  "intentKeyword": "demo_booked"
}
'

import requests

url = "https://ext.gojiberry.ai/v1/contact/{id}/signals"

payload = {
    "intent": "Booked a demo from the pricing page",
    "intentKeyword": "demo_booked"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({intent: 'Booked a demo from the pricing page', intentKeyword: 'demo_booked'})
};

fetch('https://ext.gojiberry.ai/v1/contact/{id}/signals', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ext.gojiberry.ai/v1/contact/{id}/signals",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'intent' => 'Booked a demo from the pricing page',
    'intentKeyword' => 'demo_booked'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://ext.gojiberry.ai/v1/contact/{id}/signals"

	payload := strings.NewReader("{\n  \"intent\": \"Booked a demo from the pricing page\",\n  \"intentKeyword\": \"demo_booked\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://ext.gojiberry.ai/v1/contact/{id}/signals")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"intent\": \"Booked a demo from the pricing page\",\n  \"intentKeyword\": \"demo_booked\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ext.gojiberry.ai/v1/contact/{id}/signals")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"intent\": \"Booked a demo from the pricing page\",\n  \"intentKeyword\": \"demo_booked\"\n}"

response = http.request(request)
puts response.read_body

{
  "created": true,
  "contact": {
    "id": 123,
    "firstName": "<string>",
    "lastName": "<string>",
    "fullName": "<string>",
    "bounced": false,
    "unsubscribed": false,
    "redListed": false,
    "blocked": false,
    "companyBlocked": false,
    "emailEnriched": false,
    "phoneEnriched": false,
    "enrichingEmail": false,
    "enrichingPhone": false,
    "userId": 123,
    "user": {},
    "readyForCampaign": false,
    "hasStartedCampaign": false,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "profileBaseline": "<string>",
    "location": "<string>",
    "companyLocation": "<string>",
    "jobTitle": "<string>",
    "positionDates": "<string>",
    "company": "<string>",
    "companySize": "<string>",
    "companyUrl": "<string>",
    "website": "<string>",
    "industry": "<string>",
    "email": "<string>",
    "email_2": "<string>",
    "email_3": "<string>",
    "secondEmail": "<string>",
    "thirdEmail": "<string>",
    "phone": "<string>",
    "phone_2": "<string>",
    "phone_3": "<string>",
    "secondPhone": "<string>",
    "thirdPhone": "<string>",
    "profileId": "<string>",
    "linkedinMemberId": 123,
    "profileUrl": "<string>",
    "picture": "<string>",
    "openToWork": true,
    "skills": [
      "<string>"
    ],
    "linkedinIdentifier": "<string>",
    "note": "<string>",
    "user_note": "<string>",
    "intent": "<string>",
    "intent_scoring": 123,
    "total_scoring": 123,
    "intent_type": {},
    "intent_keyword": "<string>",
    "scoring": 123,
    "score_reasoning": "<string>",
    "fit": "qualified",
    "rejectedAt": "2023-11-07T05:31:56Z",
    "rejectedByUserId": 123,
    "rejectionReason": "<string>",
    "rejectionReasonText": "<string>",
    "deepResearchStartedAt": "2023-11-07T05:31:56Z",
    "deepResearchEndedAt": "2023-11-07T05:31:56Z",
    "email_template": {},
    "linkedin_template": "<string>",
    "personalizedMessages": [
      "<string>"
    ],
    "destinationStatus": [
      "<string>"
    ],
    "customFields": {},
    "campaignStatus": [
      "<string>"
    ],
    "signals": [
      "<string>"
    ],
    "agentId": 123,
    "agent": {
      "id": 123,
      "name": "<string>",
      "targetJobTitles": [
        "<string>"
      ],
      "targetIndustries": [
        "<string>"
      ],
      "targetCompanySizes": [
        "<string>"
      ],
      "targetLocations": [
        "<string>"
      ],
      "targetCompanyTypes": [
        "<string>"
      ],
      "agentType": "autopilot",
      "scriptInstalled": false,
      "currentCreditUsage": 0,
      "paused": false,
      "excludeServiceProviders": false,
      "skipIcpFilter": false,
      "includeOpenToWorkProfiles": false,
      "leadWaterfall": true,
      "userId": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "additionalCriteria": "<string>",
      "variables": [
        "<string>"
      ],
      "ignoredCompanies": [
        "<string>"
      ],
      "mandatoryKeywords": [
        "<string>"
      ],
      "trackingScriptId": "<string>",
      "maxCreditUsage": 200,
      "lastRun": "2023-11-07T05:31:56Z",
      "minLeadScore": 0.75,
      "listId": 123
    },
    "listId": 123,
    "list": {
      "id": 123,
      "name": "<string>",
      "userId": 123,
      "user": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "campaignId": 123,
      "campaign": {
        "id": 123,
        "name": "<string>",
        "userId": 123,
        "active": true,
        "excludeFirstDegreeFromCampaigns": true,
        "splitLinkedinMessagesIntoConversation": false,
        "isManual": false,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "steps": [
          {}
        ],
        "skipInvitationAfterDays": 123,
        "language": "<string>",
        "tone": "professional",
        "goal": "conversations",
        "linkedinSeatId": 123
      },
      "customFields": [
        "<string>"
      ]
    },
    "state": "finished"
  }
}

Authorizations

Authorization

string

header

required

API key from Settings → API. Send it as Authorization: Bearer .

Headers

x-impersonate-user-id

string

ID of an organization member to act on behalf of. The API key user must be the owner of the organization and the target user must belong to the same organization.

Path Parameters

number

required

Body

application/json

intent

string

Human-readable description of what the lead did, as it should appear on the contact

Example:

"Booked a demo from the pricing page"

intentType

enum<string>

Leave empty for first-party signals. Only set it to record one of the signal types detected by Gojiberry agents.

Available options:

SEARCH_KEYWORD,

SEARCH_KEYWORD_COMMENT,

SEARCH_KEYWORD_LIKE,

SEARCH_KEYWORD_POST,

EVENT_KEYWORD,

GROUP_KEYWORD,

COMPETITOR_PAGE_URL,

INFLUENCER_PAGE_URL,

YOUR_COMPANY,

RECENT_ACTIVITY,

RECENTLY_CHANGED_JOB,

RECENT_FUNDING_EVENT,

VISITED_PROFILE,

YOUR_PROFILE,

YOUR_COMPANY_FOLLOWERS,

JOB_SEARCH,

HIRING,

HIRING_SURGE,

TECHNOLOGY,

NEW_DECISION_MAKER,

LOOKALIKE,

WEBSITE_VISITOR

intentKeyword

string

Short label for the signal, e.g. trial_signup, demo_booked or webinar_attended

Maximum string length: 255

Example:

"demo_booked"

Response

Whether the signal was recorded, and the contact with its up-to-date signals

created

boolean

false when the contact already had this signal (only possible when intentType is set)

contact

object

Show child attributes

⌘I

Add a signal to a contact (first-party signals)

curl --request POST \
  --url https://ext.gojiberry.ai/v1/contact/{id}/signals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "intent": "Booked a demo from the pricing page",
  "intentKeyword": "demo_booked"
}
'

import requests

url = "https://ext.gojiberry.ai/v1/contact/{id}/signals"

payload = {
    "intent": "Booked a demo from the pricing page",
    "intentKeyword": "demo_booked"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({intent: 'Booked a demo from the pricing page', intentKeyword: 'demo_booked'})
};

fetch('https://ext.gojiberry.ai/v1/contact/{id}/signals', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ext.gojiberry.ai/v1/contact/{id}/signals",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'intent' => 'Booked a demo from the pricing page',
    'intentKeyword' => 'demo_booked'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://ext.gojiberry.ai/v1/contact/{id}/signals"

	payload := strings.NewReader("{\n  \"intent\": \"Booked a demo from the pricing page\",\n  \"intentKeyword\": \"demo_booked\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://ext.gojiberry.ai/v1/contact/{id}/signals")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"intent\": \"Booked a demo from the pricing page\",\n  \"intentKeyword\": \"demo_booked\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ext.gojiberry.ai/v1/contact/{id}/signals")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"intent\": \"Booked a demo from the pricing page\",\n  \"intentKeyword\": \"demo_booked\"\n}"

response = http.request(request)
puts response.read_body

{
  "created": true,
  "contact": {
    "id": 123,
    "firstName": "<string>",
    "lastName": "<string>",
    "fullName": "<string>",
    "bounced": false,
    "unsubscribed": false,
    "redListed": false,
    "blocked": false,
    "companyBlocked": false,
    "emailEnriched": false,
    "phoneEnriched": false,
    "enrichingEmail": false,
    "enrichingPhone": false,
    "userId": 123,
    "user": {},
    "readyForCampaign": false,
    "hasStartedCampaign": false,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "profileBaseline": "<string>",
    "location": "<string>",
    "companyLocation": "<string>",
    "jobTitle": "<string>",
    "positionDates": "<string>",
    "company": "<string>",
    "companySize": "<string>",
    "companyUrl": "<string>",
    "website": "<string>",
    "industry": "<string>",
    "email": "<string>",
    "email_2": "<string>",
    "email_3": "<string>",
    "secondEmail": "<string>",
    "thirdEmail": "<string>",
    "phone": "<string>",
    "phone_2": "<string>",
    "phone_3": "<string>",
    "secondPhone": "<string>",
    "thirdPhone": "<string>",
    "profileId": "<string>",
    "linkedinMemberId": 123,
    "profileUrl": "<string>",
    "picture": "<string>",
    "openToWork": true,
    "skills": [
      "<string>"
    ],
    "linkedinIdentifier": "<string>",
    "note": "<string>",
    "user_note": "<string>",
    "intent": "<string>",
    "intent_scoring": 123,
    "total_scoring": 123,
    "intent_type": {},
    "intent_keyword": "<string>",
    "scoring": 123,
    "score_reasoning": "<string>",
    "fit": "qualified",
    "rejectedAt": "2023-11-07T05:31:56Z",
    "rejectedByUserId": 123,
    "rejectionReason": "<string>",
    "rejectionReasonText": "<string>",
    "deepResearchStartedAt": "2023-11-07T05:31:56Z",
    "deepResearchEndedAt": "2023-11-07T05:31:56Z",
    "email_template": {},
    "linkedin_template": "<string>",
    "personalizedMessages": [
      "<string>"
    ],
    "destinationStatus": [
      "<string>"
    ],
    "customFields": {},
    "campaignStatus": [
      "<string>"
    ],
    "signals": [
      "<string>"
    ],
    "agentId": 123,
    "agent": {
      "id": 123,
      "name": "<string>",
      "targetJobTitles": [
        "<string>"
      ],
      "targetIndustries": [
        "<string>"
      ],
      "targetCompanySizes": [
        "<string>"
      ],
      "targetLocations": [
        "<string>"
      ],
      "targetCompanyTypes": [
        "<string>"
      ],
      "agentType": "autopilot",
      "scriptInstalled": false,
      "currentCreditUsage": 0,
      "paused": false,
      "excludeServiceProviders": false,
      "skipIcpFilter": false,
      "includeOpenToWorkProfiles": false,
      "leadWaterfall": true,
      "userId": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "additionalCriteria": "<string>",
      "variables": [
        "<string>"
      ],
      "ignoredCompanies": [
        "<string>"
      ],
      "mandatoryKeywords": [
        "<string>"
      ],
      "trackingScriptId": "<string>",
      "maxCreditUsage": 200,
      "lastRun": "2023-11-07T05:31:56Z",
      "minLeadScore": 0.75,
      "listId": 123
    },
    "listId": 123,
    "list": {
      "id": 123,
      "name": "<string>",
      "userId": 123,
      "user": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "campaignId": 123,
      "campaign": {
        "id": 123,
        "name": "<string>",
        "userId": 123,
        "active": true,
        "excludeFirstDegreeFromCampaigns": true,
        "splitLinkedinMessagesIntoConversation": false,
        "isManual": false,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "steps": [
          {}
        ],
        "skipInvitationAfterDays": 123,
        "language": "<string>",
        "tone": "professional",
        "goal": "conversations",
        "linkedinSeatId": 123
      },
      "customFields": [
        "<string>"
      ]
    },
    "state": "finished"
  }
}

Getting Started

API reference

Add a signal to a contact

Authorizations

Headers

Path Parameters

Body

Response