Overview

Your Implementation Required

This endpoint must be implemented on your server

Enginy logs conversation activity (LinkedIn messages, InMails, connection requests, and emails) to your Custom CRM. Implement this endpoint so Enginy can create activity records whenever a message is sent or received.

When Activities Are Created

Enginy creates activity records when:

Event	Activity Type	Direction
LinkedIn message sent	`LINKEDIN`	`OUTBOUND`
LinkedIn message received	`LINKEDIN`	`INBOUND`
LinkedIn InMail sent	`LINKEDIN_INMAIL`	`OUTBOUND`
LinkedIn InMail received	`LINKEDIN_INMAIL`	`INBOUND`
Connection request sent	`LINKEDIN_CONNECTION`	`OUTBOUND`
Connection request accepted	`LINKEDIN_CONNECTION`	`INBOUND`
Email sent	`EMAIL`	`OUTBOUND`
Email received	`EMAIL`	`INBOUND`

Activities are only logged for campaigns with message sync enabled. Configure this in your campaign settings.

Subject Format

Enginy formats the subject field to provide context about the message: Outbound messages (from your team):

[{sequenceIndex}/{sequenceCount}] [FROM {YourCompany}] {SenderName}

Example: [1/3] [FROM Acme Corp] John Smith Inbound messages (from the contact):

[{ContactCompany}] {ContactFirstName} {ContactLastName}

Example: [TechStartup Inc] Jane Doe

The sequence index (e.g., [1/3]) indicates this is message 1 of 3 in the sequence. This helps track campaign progress.

Create Activity

Creates a new activity record in your CRM.

POST /activities

Request Body

Field	Type	Required	Description
`type`	string	Yes	Activity type: `EMAIL`, `LINKEDIN`, `LINKEDIN_CONNECTION`, `LINKEDIN_INMAIL`
`subject`	string	No	Activity subject/title
`body`	string	No	Activity body or message content (may include HTML)
`direction`	string	No	`INBOUND` or `OUTBOUND`
`ownerId`	string	No	Owner/user ID in your CRM
`occurredAt`	string (ISO 8601)	No	When the activity happened
`contactId`	string	No	Associated contact/lead CRM ID
`companyId`	string	No	Associated company CRM ID
`metadata`	object	No	Optional metadata (e.g., sequence index, message ID)

Typical metadata keys include messageId, sequenceIndex, and sequenceMessageCount. You can store them for traceability or ignore them.

Example: Email Activity

{
  "type": "EMAIL",
  "subject": "[1/3] Re: Partnership Opportunity",
  "body": "<div>Hi Jane, Thanks for your interest...</div>",
  "direction": "OUTBOUND",
  "ownerId": "user-123",
  "occurredAt": "2024-12-31T10:00:00Z",
  "contactId": "contact-456",
  "companyId": "company-789",
  "metadata": {
    "sequenceIndex": 1,
    "sequenceMessageCount": 3,
    "messageId": "msg-abc123"
  }
}

Example: LinkedIn Outbound Message

{
  "type": "LINKEDIN",
  "subject": "[1/3] [FROM Acme Corp] John Smith",
  "body": "Hi Jane, I noticed your company is expanding...",
  "direction": "OUTBOUND",
  "ownerId": "user-123",
  "occurredAt": "2024-12-31T10:00:00Z",
  "contactId": "contact-456",
  "companyId": "company-789",
  "metadata": {
    "messageId": "linkedin-msg-123",
    "sequenceIndex": 1,
    "sequenceMessageCount": 3
  }
}

Example: LinkedIn Inbound Reply

{
  "type": "LINKEDIN",
  "subject": "[TechStartup Inc] Jane Doe",
  "body": "Thanks for reaching out. Happy to chat!",
  "direction": "INBOUND",
  "ownerId": "user-123",
  "occurredAt": "2024-12-31T11:00:00Z",
  "contactId": "contact-456",
  "companyId": "company-789",
  "metadata": {
    "messageId": "linkedin-msg-456"
  }
}

Response

Return the created activity with at least an id field:

{
  "id": "activity-abc123",
  "type": "EMAIL",
  "subject": "[1/3] Re: Partnership Opportunity",
  "direction": "OUTBOUND",
  "occurredAt": "2024-12-31T10:00:00Z"
}

The id field is required in the response. Enginy stores this ID to prevent duplicate activity logs.

Activity Schema Reference

Field	Type	Required	Description
`id`	string	Yes (response)	Unique identifier for the activity
`type`	string	Yes	`EMAIL`, `LINKEDIN`, `LINKEDIN_CONNECTION`, `LINKEDIN_INMAIL`
`subject`	string	No	Activity subject/title
`body`	string	No	Activity body/content (may contain HTML)
`direction`	string	No	`INBOUND` or `OUTBOUND`
`ownerId`	string	No	Assigned user ID
`occurredAt`	string (ISO 8601)	No	Timestamp of the activity
`contactId`	string	No	Associated contact/lead CRM ID
`companyId`	string	No	Associated company CRM ID
`metadata`	object	No	Additional metadata

Testing Your Activities API

Test Email Activity

curl -X POST https://your-api.com/activities \
  -H "X-API-Key: your-secret-key" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "EMAIL",
    "subject": "Test email activity",
    "direction": "OUTBOUND",
    "contactId": "contact-123"
  }'

Test LinkedIn Activity

curl -X POST https://your-api.com/activities \
  -H "X-API-Key: your-secret-key" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "LINKEDIN",
    "subject": "[1/3] [FROM Acme] John Smith",
    "body": "Hi, I wanted to connect...",
    "direction": "OUTBOUND",
    "contactId": "contact-123"
  }'

Verify Response

Ensure your response includes an id field:

{
  "id": "activity-xyz789"
}

Reference Implementation

GitHub Repository

See a complete working implementation of the activities endpoint, including how to display activities in contact/company detail pages.

Getting Started

Contacts

Companies

Associations

Tasks

Activities

Users (Optional)

Examples

Your Implementation Required

When Activities Are Created

Subject Format

Create Activity

Request Body

Example: Email Activity

Example: LinkedIn Outbound Message

Example: LinkedIn Inbound Reply

Response

Activity Schema Reference

Testing Your Activities API

Reference Implementation

GitHub Repository

Your Implementation Required

​When Activities Are Created

​Subject Format

​Create Activity

​Request Body

​Example: Email Activity

​Example: LinkedIn Outbound Message

​Example: LinkedIn Inbound Reply

​Response

​Activity Schema Reference

​Testing Your Activities API

​Reference Implementation

GitHub Repository

When Activities Are Created

Subject Format

Create Activity

Request Body

Example: Email Activity

Example: LinkedIn Outbound Message

Example: LinkedIn Inbound Reply

Response

Activity Schema Reference

Testing Your Activities API

Reference Implementation