v1

latestOpenAPI 3.0.3Proprietary2026-08-0656136286.9 KB
Webhooks

Update Subscription

Updates an existing webhook subscription. All fields are optional.

Endpoint: (PATCH) https://api.lusha.com/api/subscriptions/{id}


Reactivating Disabled Subscriptions:

When setting isActive: true on a previously disabled subscription, the system automatically:

  • Clears the blockReason field
  • Clears the blockedAt timestamp
  • Resets the retry counter

Regenerating Secrets:

Set regenerateSecret: true to generate a new webhook secret. The new secret:

  • Affects all subscriptions for your account
  • Is only shown once in the response
  • Immediately invalidates the old secret

patch/api/subscriptions/{id}

Path parameters

idstring required

Subscription ID

Request body

signalTypesstring[]

New signal types to subscribe to

urlstring uri

New webhook URL

namestring

New subscription name

isActiveboolean

Enable or disable subscription

regenerateSecretboolean

Generate new webhook secret (secret will be returned in response)

Response

Subscription updated successfully

idstring
entityType'contact' | 'company'
entityIdstring
signalTypesstring[]
urlstring uri
namestring
isActiveboolean
secretstring

Webhook secret (only returned during creation or regeneration)

createdAtstring date-time
updatedAtstring date-time

Example response

{
  "id": "507f1f77bcf86cd799439011",
  "entityType": "contact",
  "entityId": "123456",
  "signalTypes": [
    "promotion",
    "companyChange"
  ],
  "url": "https://example.com/webhooks/lusha",
  "name": "Contact Promotion Tracker",
  "isActive": true,
  "secret": "whsec_abc123def456ghi789jkl012mno345pqr678stu901vwx234yz",
  "createdAt": "2026-01-14T10:00:00.000Z",
  "updatedAt": "2026-01-14T10:00:00.000Z"
}