The Keyplay Intent API allows you to send behavioral or intent data directly to Keyplay for analysis. This enables your team to aggregated intent signals and associate them with companies in your CRM.
This documentation provides technical details for developers who wish to make direct API calls without using an iPaaS or middleware solution.
Base URL
https://api.keyplay.io/v1/intent_data
Authorization
All requests require Bearer Token authorization.
Use your Keyplay API key as the bearer token in the request header.
Example:
Authorization: Bearer your_api_key
Request Method
POST
The Intent API accepts POST requests with a JSON body.
Request Body Parameters
Parameter | Required | Type | Description |
| ✅ |
| A unique identifier representing the data source or system sending the intent signal. This must be configured in advance in Keyplay. |
| ✅ |
| The company domain associated with the signal (e.g., |
| ❌ |
| Optional timestamp representing when the event occurred. Use this only if there is a significant lag between event occurrence and API submission. Format: |
Example Request
curl -X POST https://api.keyplay.io/v1/intent_data \ -H "Authorization: Bearer your_api_key" \ -H "Content-Type: application/json" \ -d '{ "source_id": "68e93229de87c9c29ff25de9", "domain": "keyplay.io", "timestamp": "2025-01-06T20:49:28.345+00:01" }'Response
The API will return a 200 OK response confirming receipt of the event.
Error Handling
In case of an error, the API will return an appropriate HTTP status code (typically 400) along with a JSON error message.
Example Error Response:
{
"error": {
"type": "invalid_request_error",
"message": "Invalid domain: Required",
"param": "domain"
}
}Rate Limiting
To ensure reliability and consistency, it is recommended to stay under 5 requests per second when sending intent data to the Keyplay API.
Best Practices
Throttle requests: Maintain a rate under 5 requests per second.
Include timestamps only when needed: Avoid unnecessary complexity unless there is significant delay between event occurrence and submission.
Log and monitor errors: Capture and review API errors for debugging and validation.