Skip to main content
POST
/
api
/
v2
/
analytics
/
webhook
/
receive
/
generic
/
generic
/
{eventType}
Receive generic webhook events
curl --request POST \
  --url https://app.octavehq.com/api/v2/analytics/webhook/receive/generic/generic/{eventType} \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "eventTimestamp": "2024-02-03T10:30:00Z",
  "subject": "Follow up email",
  "body": {
    "text": "Email content here..."
  },
  "from": {
    "email": "sender@company.com",
    "name": "Sarah Johnson"
  },
  "to": [
    {
      "email": "recipient@prospect.com",
      "name": "John Smith"
    }
  ]
}
'
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "received": true,
  "connection": {
    "providerName": "INSTANTLY",
    "shouldProcess": true,
    "connectionMethod": "WEBHOOK"
  },
  "additionalData": {}
}

Authorizations

api_key
string
header
required

Path Parameters

eventType
enum<string>
required

Type of event being sent

Available options:
emails,
calls,
crm
Example:

"emails"

Query Parameters

api_key
string

Provide api key if not in header

Body

application/json

Generic webhook payload

{key}
unknown

Response

Webhook received successfully

_metadata
object
required
received
boolean
required

Whether the payload was received

connection
object
required

Connection details

additionalData
object

Additional data about the processed event