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

# Relayhook API

Relayhook webhook management API for creating, subscribing, and managing webhooks with data polling capabilities. The API exposes 11 endpoints secured with apiKey authentication.

## For AI agents

Programmatically get usage statistics, get available plans. Covers 11 operations with apiKey authentication.

## Scope

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

## Capabilities

- Get Usage Statistics
- Generate New Webhook ID
- Subscribe to Webhook
- Unsubscribe from Webhook
- List Webhook Names
- Send Data via POST

## Use cases

### Developer Tools Operations

Use the Relayhook API to perform developer tools operations programmatically. The API provides 11 endpoints covering core functionality including get usage statistics, get available plans, generate new webhook id.

Example prompt: Call GET /usage to get usage statistics

### Automated Account Management

Automate account operations by combining multiple Relayhook API endpoints. Agents can get available plans and then generate new webhook id in a single workflow.

Example prompt: Call GET /plans to get available plans, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Relayhook 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 'get usage statistics', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/usage` | Get Usage Statistics |
| GET | `/plans` | Get Available Plans |
| GET | `/webhook/new` | Generate New Webhook ID |
| POST | `/webhook/subscribe` | Subscribe to Webhook |
| POST | `/webhook/unsubscribe` | Unsubscribe from Webhook |
| GET | `/webhook/names` | List Webhook Names |
| POST | `/data` | Send Data via POST |
| GET | `/data` | Send Data via GET |

## Key resources

- **Account** — Operations related to Account
- **Data** — Operations related to Data
- **Webhooks** — Operations related to Webhooks

## 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:** 48 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 85 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 54 / 100
  - Agent Usability: 94 / 100
  - Security: 15 / 100
  - AI Discoverability: 64 / 100
- **View full report:** https://jentic.com/apis/relayhook.com/relayhook/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 Relayhook by hand means passing its API key as a query parameter and managing its webhook subscribe and data endpoints yourself. Through Jentic you install once, import Relayhook from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Relayhook identifies webhooks in the request body rather than the URL path, so limit the agent to the operations it needs, such as reading usage or listing webhook names. You choose the operations it may call, so subscribe and unsubscribe are not included unless you add them.
- **Credential handling:** Your Relayhook 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 'get usage statistics' or 'subscribe to a webhook', and Jentic returns the matching Relayhook operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the Relayhook API use?

The Relayhook API uses an API key passed in the `apiKey` query. 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 get usage statistics with the Relayhook API?

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

### What are the rate limits for the Relayhook 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 get usage statistics through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'get usage statistics'. Jentic returns the matching Relayhook API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

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

The Relayhook API exposes 11 endpoints covering account, data, webhooks operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which Relayhook operations and credentials the agent may use. Since Relayhook identifies webhooks in the request body rather than the URL path, you scope the agent to only the operations it needs, such as reading usage statistics with GET /usage or listing webhook names with GET `/webhook/names.` Subscribe and unsubscribe are not available to the agent unless you explicitly grant them.