Gulliver CRM API

The GulliverCRM API enables integration with external systems for managing application data. This guide describes currently available endpoints, their parameters, and usage examples.

API Fundamentals

• Subdomain: All requests must be made to your specific subdomain (e.g., application.gullivercrm.com)
• Authentication: All requests require authorization using an access token or endpoint-specific method
• Response format: Endpoints return JSON responses
• Error handling: Standard HTTP status codes are used:
  • 200 OK - Successful request
  • 400 Bad Request - Validation error or incorrect data
  • 401 Unauthorized - Authorization required
  • 404 Not Found - Resource not available
  • 500 Internal Server Error - Server-side error
• New endpoints: Added based on client requirements

---

API Endpoints

Add Deal via API

Description

This endpoint allows adding new deals to the system via API. Supports dynamic addition of custom fields in the request body.

Method

POST

URL

api/pipeline/deal/add/:name

URL Parameters

• name (required) - Deal source (e.g., tilda, webform). Must match existing deal sources

Request Body

JSON-formatted deal data. Example:

{
  "phone": "+375291234567", // international format
  "stage": "stageId", // pipeline stage ID
  "name": "John",
  "surname": "Doe",
  "birth": "2025-03-12T21:00:00.000Z", // ISO 8601 format
  "contact": "john@example.com",
  "customField1Id": "Value1",
  "customField2Id": "Value2",
  "secret": "secret-token" // from integration settings
}

Response

Successful response returns:

{
  "statusCode": 200,
  "message": "Deal successfully added"
}

Example Request

curl -X POST "https://application.gullivercrm.com/api/pipeline/deal/add/tilda" \
-H "Content-Type: application/json" \
-d '{
  "phone": "+375291234567",
  "stage": "stageId",
  "name": "John",
  "surname": "Doe",
  "birth": "2025-03-12T21:00:00.000Z",
  "contact": "john@example.com",
  "customField1": "Value1",
  "customField2": "Value2",
  "secret": "34565756ggfe33345"
}'

Error Handling

Validation errors return:

{
  "statusCode": 400,
  "message": "Validation failed!"
}

Invalid deal source returns 404 Not Found.

---

Test Deal Endpoint

Description

Simulates deal creation for integration testing (no actual data is created).

Method

POST

URL

api/pipeline/deal/add/:name/test

URL Parameters

• name (required) - Deal source identifier

Response

{
  "statusCode": 200,
  "message": "Test successful"
}

Example Request

curl -X POST "https://api.example.com/deal/add/tilda/test" \
-H "Content-Type: application/json"

Webhooks in GulliverCRM

Webhooks enable automatic data transmission to external systems when automation triggers activate. Multiple webhooks can be configured per trigger.

Webhook Fundamentals

• Automations: Webhooks trigger via automations containing triggers (conditions) and actions
• Error handling: Failed webhook attempts are logged and may retry based on automation settings

---

Webhook: External URL Activation

Description

Sends POST request to specified URL with automatically generated payload data when trigger conditions are met.

Method

POST

URL

https://requestb.in/xxxxxxxxx

Parameters

• url (required) - Target endpoint URL

Request Body

Automatically generated event data

Trigger

• Trigger type: Cell status update (cellStatusUpdated)

Action

• Action type: Webhook activation
• Parameters:
  • URL: https://requestb.in/xxxxxxxxx

Result

System sends POST request to target URL when cell status changes occur.

---

Webhook Implementation Guidelines

1. URL verification: Ensure webhook URLs are correct and publicly accessible
2. Error handling: Configure external systems to properly process requests and return appropriate HTTP codes

---

P.S. 🧩🏆

You can now add webhooks to your automations using this guide. Happy automating! 🚀

Key improvements:

1. Professional technical writing style
2. Consistent terminology
3. Proper API documentation formatting
4. Natural English translations
5. Preserved all code blocks and markdown
6. Maintained visual elements (images, emojis)
7. Clear error handling documentation
8. Standardized date/time formats
9. Improved readability while keeping technical accuracy