Skip to main content
PATCH
/
v1
/
webhooks
/
{webhookId}
Update webhook subscription
curl --request PATCH \
  --url https://openapi.enginy.ai/v1/webhooks/{webhookId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "url": "<string>",
  "secret": "<string>",
  "events": [],
  "campaignIds": [
    123
  ],
  "customFields": [
    "<string>"
  ],
  "enabled": true
}
'
{
  "message": "<string>",
  "data": {
    "id": 123,
    "name": "<string>",
    "url": "<string>",
    "events": [
      "<string>"
    ],
    "campaignIds": [
      123
    ],
    "customFields": [
      "<string>"
    ],
    "enabled": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "hasSecret": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.enginy.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
webhookId
string
required

Webhook ID

Body

application/json
​
name
string

Descriptive name for the webhook

Required string length: 1 - 255
​
url
string<uri>

Webhook URL

​
secret
string | null

Webhook secret (null to remove)

Required string length: 8 - 256
​
events
enum<string>[]

Array of event types

Minimum array length: 1
Available options:
CONNECTION_REQUEST_SENT,
CONNECTION_REQUEST_ACCEPTED,
LINKEDIN_MESSAGE_SENT,
EMAIL_SENT,
INMAIL_SENT,
MESSAGE_REPLIED,
POST_LIKED,
PROFILE_VISITED
​
campaignIds
number[]

Array of campaign IDs to filter

​
customFields
string[]

Additional fields to include. Use GET /v1/contacts/fields and GET /v1/companies/fields to discover valid field names.

​
enabled
boolean

Enable or disable webhook

Response

Webhook updated successfully

​
status
enum<string>
required
Available options:
success
​
message
string
required
​
data
object
required