Register and manage async job notifications.
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/generect-com:generect-com-11-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: Generect 11. Webhooks API
description: 'Welcome to the Generect API documentation. Here we will help you integrate and use our API.
API base url: `https://api.generect.com` — every path below is relative to this host. Newer endpoints live under `/api/v1/...`, legacy endpoints under `/api/...`; use each path exactly as documented.
Protocol: `HTTPS`
# Authentication
Get your API token from the Generect app settings and send it in the `Authorization` header with the required `Token` prefix.
Example: `Authorization: Token xxxxxxxxx`
# Rate limits
There is no monthly request quota. What you can run is bounded by your account balance and by the parallel-request caps on the Limits page. Pricing depends on the operation and the number of results returned, and may increase with additional data flags. For exact pricing, see each endpoint''s Pricing section or your billing settings: https://app.generect.com/settings/billing
# Note
_Every endpoint must include the trailing `/`. Requests without the trailing slash may fail._'
version: 1.0.0
contact: {}
servers:
- url: https://api.generect.com
security:
- apiKey: []
tags:
- name: 11. Webhooks
description: Register and manage async job notifications.
paths:
/api/v1/webhooks/:
get:
tags:
- 11. Webhooks
summary: List webhooks
description: List registered webhook endpoints.
responses:
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'200':
description: Registered webhooks
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookList'
operationId: getApiV1Webhooks
x-operation-id-source: derived
post:
tags:
- 11. Webhooks
summary: Register webhook
description: Register a webhook endpoint for async notifications.
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- url
- events
properties:
url:
type: string
description: Your HTTPS endpoint URL to receive webhook events.
example: https://your-app.com/webhook
events:
type: array
description: Events to subscribe to.
items:
type: string
enum:
- email.find.bulk.completed
- phone.find.bulk.completed
- enrich.lead.bulk.completed
- enrich.company.bulk.completed
- status.incident.created
- status.incident.updated
- status.incident.resolved
- status.maintenance.started
- status.maintenance.completed
example:
- email.find.bulk.completed
secret:
type: string
description: Secret for HMAC signature verification of incoming webhook payloads.
example: your-secret-for-signature
responses:
'400':
description: Validation error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Validation error:
value:
status: error
status_code: 400
detail:
events:
- 'Unsupported events: [''email.find.completed'']. Allowed: [''email.find.bulk.completed'', ''enrich.company.bulk.completed'', ''enrich.lead.bulk.completed'', ''phone.find.bulk.completed'', ''status.incident.created'', ''status.incident.resolved'', ''status.incident.updated'', ''status.maintenance.completed'', ''status.maintenance.started'']'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'201':
description: Webhook registered
content:
application/json:
schema:
$ref: '#/components/schemas/Webhook'
operationId: postApiV1Webhooks
x-operation-id-source: derived
/api/v1/webhooks/{id}/:
parameters:
- name: id
in: path
required: true
schema:
type: string
example: wh_123
get:
tags:
- 11. Webhooks
summary: Retrieve webhook
description: Retrieve a single registered webhook endpoint.
responses:
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'200':
description: Webhook
content:
application/json:
schema:
$ref: '#/components/schemas/Webhook'
operationId: getApiV1WebhooksById
x-operation-id-source: derived
put:
tags:
- 11. Webhooks
summary: Update webhook
description: Replace a webhook endpoint's configuration.
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- url
- events
properties:
url:
type: string
example: https://your-app.com/webhook
events:
type: array
items:
type: string
enum:
- email.find.bulk.completed
- phone.find.bulk.completed
- enrich.lead.bulk.completed
- enrich.company.bulk.completed
- status.incident.created
- status.incident.updated
- status.incident.resolved
- status.maintenance.started
- status.maintenance.completed
secret:
type: string
responses:
'400':
description: Validation error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Validation error:
value:
status: error
status_code: 400
detail:
events:
- 'Unsupported events: [''email.find.completed'']. Allowed: [''email.find.bulk.completed'', ''enrich.company.bulk.completed'', ''enrich.lead.bulk.completed'', ''phone.find.bulk.completed'', ''status.incident.created'', ''status.incident.resolved'', ''status.incident.updated'', ''status.maintenance.completed'', ''status.maintenance.started'']'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'200':
description: Webhook updated
content:
application/json:
schema:
$ref: '#/components/schemas/Webhook'
operationId: putApiV1WebhooksById
x-operation-id-source: derived
patch:
tags:
- 11. Webhooks
summary: Partially update webhook
description: Update selected fields of a webhook endpoint.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
url:
type: string
events:
type: array
items:
type: string
enum:
- email.find.bulk.completed
- phone.find.bulk.completed
- enrich.lead.bulk.completed
- enrich.company.bulk.completed
- status.incident.created
- status.incident.updated
- status.incident.resolved
- status.maintenance.started
- status.maintenance.completed
secret:
type: string
responses:
'400':
description: Validation error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
Validation error:
value:
status: error
status_code: 400
detail:
events:
- 'Unsupported events: [''email.find.completed'']. Allowed: [''email.find.bulk.completed'', ''enrich.company.bulk.completed'', ''enrich.lead.bulk.completed'', ''phone.find.bulk.completed'', ''status.incident.created'', ''status.incident.resolved'', ''status.incident.updated'', ''status.maintenance.completed'', ''status.maintenance.started'']'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'200':
description: Webhook updated
content:
application/json:
schema:
$ref: '#/components/schemas/Webhook'
operationId: patchApiV1WebhooksById
x-operation-id-source: derived
delete:
tags:
- 11. Webhooks
summary: Delete webhook
description: Remove a registered webhook endpoint.
responses:
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'204':
description: Webhook removed
operationId: deleteApiV1WebhooksById
x-operation-id-source: derived
/api/v1/webhooks/{id}/test/:
post:
tags:
- 11. Webhooks
summary: Test webhook
description: Send a sample `webhook.test` delivery to this webhook's URL.
parameters:
- name: id
in: path
required: true
schema:
type: string
example: wh_123
responses:
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'202':
description: Test delivery enqueued
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookTestResponse'
example:
data:
delivery_id: d4e5f6a7-8b9c-40d1-a2e3-f4a5b6c7d8e9
status: pending
meta:
event: webhook.test
operationId: postApiV1WebhooksByIdTest
x-operation-id-source: derived
components:
responses:
Forbidden:
description: Authenticated, but the account/plan is not allowed to use this endpoint.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
status: error
status_code: 403
detail: You do not have permission to perform this action.
Unauthorized:
description: Missing or invalid API token.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
status: error
status_code: 401
detail: Authentication credentials were not provided.
NotFound:
description: Resource or job not found (or not owned by the caller).
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
status: error
status_code: 404
detail: Not found.
schemas:
Webhook:
type: object
properties:
id:
type: string
description: Webhook identifier.
url:
type: string
description: Your HTTPS endpoint that receives events.
events:
type: array
items:
type: string
description: Subscribed event types.
secret:
type: string
description: Secret used for HMAC signature verification.
is_active:
type: boolean
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
WebhookTestResponse:
type: object
properties:
data:
type: object
properties:
delivery_id:
type: string
description: Identifier of the test delivery.
status:
type: string
description: Delivery status (pending until your endpoint responds).
meta:
type: object
properties:
event:
type: string
description: Always "webhook.test".
Error:
type: object
description: Standard error envelope returned for 4xx/5xx responses.
properties:
status:
type: string
example: error
status_code:
type: integer
example: 400
detail:
description: 'Human-readable message (string) for most errors, or a field-level validation map ({ field: [messages] }) for 400 validation errors.'
example: Person does not exist
WebhookList:
type: array
description: Registered webhooks.
items:
$ref: '#/components/schemas/Webhook'
securitySchemes:
apiKey:
type: apiKey
in: header
name: Authorization
description: 'Use the required Token prefix. Example: Authorization: Token xxxxxxxxx'