canonical: https://jentic.com/apis/snapengage.com/snapengage

# SnapEngage API

SnapEngage is a live chat platform. The API provides agent status management, bot integration, and chat log retrieval. The API exposes 5 endpoints secured with apiKey authentication.

## For AI agents

Programmatically send agent status to snapengage, retrieve chat logs. Covers 5 operations with apiKey authentication.

## Scope

Does not handle payments, crm, or developer tools - use for communications only.

## Capabilities

- Send agent status to SnapEngage
- Retrieve chat logs
- Integrate SnapEngage API into automated workflows
- Query and filter SnapEngage API records by parameters
- Monitor SnapEngage API operational status and events

## Use cases

### Communications Operations

Use the SnapEngage API to perform communications operations programmatically. The API provides 5 endpoints covering core functionality including send agent status to snapengage, retrieve chat logs, retrieve a single chat log.

Example prompt: Call POST /agentstatus to send agent status to snapengage

### Automated Agent Status Management

Automate agent status operations by combining multiple SnapEngage API endpoints. Agents can retrieve chat logs and then retrieve a single chat log in a single workflow.

Example prompt: Call GET /logs to retrieve chat logs, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call SnapEngage API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'send agent status to snapengage', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/agentstatus` | Send agent status to SnapEngage |
| GET | `/logs` | Retrieve chat logs |
| GET | `/logs/{caseId}` | Retrieve a single chat log |
| POST | `/bot/message` | Send a bot message |
| POST | `/bot/typing` | Send bot typing indicator |

## Key resources

- **Agent Status** — Operations related to Agent Status
- **Bot** — Operations related to Bot
- **Chat Logs** — Operations related to Chat Logs

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 55 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 59 / 100
  - AI-Readiness & Agent Experience: 33 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 60 / 100
- **View full report:** https://jentic.com/apis/snapengage.com/snapengage/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the SnapEngage API by hand means passing your API key in the Authorization header, pointing at the snapengage.com/api/v2 host, and wiring bot messaging calls yourself. Through Jentic you install once, import the SnapEngage API from the API Directory, store the API key once, and your agent calls it.
- **Permission scoping:** The SnapEngage API takes its target in the request body rather than a resource id in the URL path, so limit the agent to the operations it needs, such as posting agent status or reading logs. You choose that set, so bot message and typing calls can be included or left out as you decide.
- **Credential handling:** Your SnapEngage API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'send a bot message' or 'read chat logs', and Jentic returns the matching SnapEngage API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Twilio** — Alternative communications API
- **Sendgrid** — Alternative communications API
- **Pusher** — Complementary communications API

## FAQ

### What authentication does the SnapEngage API use?

The SnapEngage API uses an API key passed in the `Authorization` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I send agent status to snapengage with the SnapEngage API?

Yes. Use the POST /agentstatus endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the SnapEngage API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I send agent status to snapengage through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'send agent status to snapengage'. Jentic returns the matching SnapEngage API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the SnapEngage API have?

The SnapEngage API exposes 5 endpoints covering agent status, bot, chat logs operations.

### Can I limit what my agent is allowed to do with the SnapEngage API?

Yes. Because you run Jentic One yourself, your own rules decide which SnapEngage operations and credentials the agent can use. Since this API takes its target in the request body rather than a resource id in the URL path, you scope the agent to only the operations it needs, such as posting agent status (POST /agentstatus) or reading chat logs (GET /logs), while leaving out bot message and typing calls (POST `/bot/message`, POST `/bot/typing`). You choose that operation set, and the stored API key is injected only for the calls you have allowed.