Documentation

Getting Started

This API is designed for custom CRM integrations that trigger automated campaign generation based on deal closure events. When a deal closes in your CRM, send us the deal data and campaigns are automatically created.

Questions? Contact our engineering team at [email protected]

Overview

The SalesCaddie API provides a single REST endpoint for your custom CRM integration. Send deal data when deals close, and we'll handle campaign creation automatically.

Quick Start

Step 1: Get Your API Key

Please reach out to us at [email protected] to receive your production API credentials. We're currently working on a self-service portal—stay tuned!

Step 2: API Endpoint

Production Environment:

Code
 
https://api.salescaddie.dev/v1

Staging Environment: Coming soon! We're working on providing a sandbox environment for testing.

Step 3: Make Your First Request

Here's a quick example of creating a campaign when a deal closes:

Code
 
curl -X POST https://api.salescaddie.dev/v1/deals \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "timestamp": "2025-01-20T14:32:15Z",
    "deal": {
      "externalId": "DEAL-12345",
      "closedAt": "2025-01-20T14:32:15Z",
      "value": 45000.0,
      "status": "closed"
    },
    "customer": {
      "firstName": "Jane",
      "lastName": "Smith",
      "phone": "+15551234567",
      "email": "[email protected]",
      "address": {
        "line1": "123 Main Street",
        "city": "Austin",
        "state": "TX",
        "zipCode": "78701"
      }
    },
    "salesRep": {
      "externalId": "REP-789",
      "firstName": "John",
      "lastName": "Doe",
      "phone": "+15559876543",
      "email": "[email protected]"
    }
  }'

Expected Response (202 Accepted):


Code
 
{
  "data": {
    "idempotencyKey": "DEAL-12345",
    "status": "accepted",
    "message": "Deal event received and queued for processing"
  }
}

That's it! Your campaign is now queued for processing. We'll handle the rest automatically.

Idempotency (Optional)

You can optionally include an Idempotency-Key header to prevent duplicate processing if the same request is sent multiple times. If you don't provide one, we'll automatically generate a unique key using your deal's externalId.

Code
 
-H "Idempotency-Key: your-unique-key"

What's Next?

→ Learn about Authentication and API keys

→ Understand Core Concepts like idempotency and phone formatting

→ Explore the API Reference for detailed endpoint documentation

→ Need help? Check out Support

Last modified on November 14, 2025

Authentication

Quick Start

Step 1: Get Your API Key

Please reach out to us at [email protected] to receive your production API credentials. We're currently working on a self-service portal—stay tuned!

Step 2: API Endpoint

Production Environment:

Code

https://api.salescaddie.dev/v1

Staging Environment: Coming soon! We're working on providing a sandbox environment for testing.

Step 3: Make Your First Request

Here's a quick example of creating a campaign when a deal closes:

Code

curl -X POST https://api.salescaddie.dev/v1/deals \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "timestamp": "2025-01-20T14:32:15Z", "deal": { "externalId": "DEAL-12345", "closedAt": "2025-01-20T14:32:15Z", "value": 45000.0, "status": "closed" }, "customer": { "firstName": "Jane", "lastName": "Smith", "phone": "+15551234567", "email": "[email protected]", "address": { "line1": "123 Main Street", "city": "Austin", "state": "TX", "zipCode": "78701" } }, "salesRep": { "externalId": "REP-789", "firstName": "John", "lastName": "Doe", "phone": "+15559876543", "email": "[email protected]" } }'

Expected Response (202 Accepted):

Code

{
  "data": {
    "idempotencyKey": "DEAL-12345",
    "status": "accepted",
    "message": "Deal event received and queued for processing"
  }
}

That's it! Your campaign is now queued for processing. We'll handle the rest automatically.

Idempotency (Optional)

Code
 
-H "Idempotency-Key: your-unique-key"