Heffl Webhooks API
The Webhooks API from Heffl — 2 operation(s) for webhooks.
The Webhooks API from Heffl — 2 operation(s) for webhooks.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/heffl-com:heffl-com-webhooks-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Heffl Public API (Legacy v1) Webhooks API
version: 1.0.0
description: Legacy Heffl REST API v1. Maintained for existing integrations. For new projects, use API v2 at https://docs.heffl.com/api-v2/introduction.
contact:
name: Heffl Support
url: https://heffl.com/support
email: support@heffl.com
servers:
- url: https://api.heffl.com/api/v1
description: Production API Server
security:
- ApiKeyAuth: []
tags:
- name: Webhooks
paths:
/webhooks:
post:
operationId: webhooks.subscribe
summary: Subscribe to webhook events
description: Creates a webhook endpoint that receives HTTP POST notifications when specified events occur.
tags:
- Webhooks
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
minLength: 1
description: 'Webhook name (e.g. ''Zapier: New Lead'')'
url:
type: string
format: uri
description: URL to receive webhook POST requests
events:
type: array
minItems: 1
items:
type: string
description: Events to subscribe to
required:
- name
- url
- events
additionalProperties: {}
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Webhook endpoint public ID
name:
type: string
url:
type: string
events:
type: array
items:
type: string
status:
type: string
secret:
type: string
description: Signing secret (one-time reveal)
createdAt:
type: string
format: date-time
x-native-type: date
required:
- id
- name
- url
- events
- status
- secret
- createdAt
get:
operationId: webhooks.list
summary: List webhook subscriptions
description: Returns webhook endpoints for your team.
tags:
- Webhooks
parameters:
- name: cursor
in: query
schema:
type: string
description: Cursor for pagination. Pass the previous response nextCursor value to fetch the next page.
allowEmptyValue: true
allowReserved: true
- name: limit
in: query
schema:
type: number
minimum: 1
maximum: 100
default: 20
description: Number of items to return (max 100)
allowEmptyValue: true
allowReserved: true
- name: search
in: query
schema:
type: string
default: ''
description: Search by webhook name or URL
allowEmptyValue: true
allowReserved: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
items:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
url:
type: string
events:
type: array
items:
type: string
status:
type: string
createdAt:
type: string
format: date-time
x-native-type: date
required:
- id
- name
- url
- events
- status
- createdAt
nextCursor:
anyOf:
- type: string
- type: 'null'
description: Cursor to fetch the next page. Null if there are no more results.
hasMore:
type: boolean
description: Whether additional results are available
required:
- items
- hasMore
/webhooks/{id}:
get:
operationId: webhooks.get
summary: Get webhook subscription
description: Returns a single webhook endpoint.
tags:
- Webhooks
parameters:
- name: id
in: path
required: true
schema:
type: string
description: Webhook endpoint public ID
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
id:
type: string
name:
type: string
url:
type: string
events:
type: array
items:
type: string
status:
type: string
createdAt:
type: string
format: date-time
x-native-type: date
required:
- id
- name
- url
- events
- status
- createdAt
delete:
operationId: webhooks.unsubscribe
summary: Unsubscribe from webhook events
description: Deletes a webhook endpoint and stops receiving events.
tags:
- Webhooks
parameters:
- name: id
in: path
required: true
schema:
type: string
description: Webhook endpoint public ID
requestBody:
required: false
content:
application/json:
schema:
type: object
properties: {}
required: []
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
required:
- success
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: API key for authentication. Get yours at app.heffl.com/settings/developers