POST
/
webhooks
Register webhook
curl --request POST \
  --url https://api.generect.com/api/v1/webhooks/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://your-app.com/webhook",
  "events": [
    "email.find.bulk.completed"
  ],
  "secret": "your-secret-for-signature"
}
'
{
  "id": "<string>",
  "url": "<string>",
  "events": [
    "<string>"
  ],
  "secret": "<string>",
  "is_active": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

​
Use Case:

Register a webhook endpoint for asynchronous job notifications.

Authorizations

​
Authorization
string
header
required

Use the required Token prefix. Example: Authorization: Token xxxxxxxxx

Body

application/json
​
url
string
required

Your HTTPS endpoint URL to receive webhook events.

Example:

"https://your-app.com/webhook"

​
events
enum<string>[]
required

Events to subscribe to.

Available options:
email.find.bulk.completed,
phone.find.bulk.completed
Example:
["email.find.bulk.completed"]
​
secret
string

Secret for HMAC signature verification of incoming webhook payloads.

Example:

"your-secret-for-signature"

Response

Webhook registered

​
id
string

Webhook identifier.

​
url
string

Your HTTPS endpoint that receives events.

​
events
string[]

Subscribed event types.

​
secret
string

Secret used for HMAC signature verification.

​
is_active
boolean
​
created_at
string<date-time>
​
updated_at
string<date-time>