Webhook map
companyCreated(companyCreated)companyDeleted(companyDeleted)companyUpdated(companyUpdated)contactCreated(contactCreated)contactDeleted(contactDeleted)contactUpdated(contactUpdated)dealCreated(dealCreated)dealDeleted(dealDeleted)dealUpdated(dealUpdated)ticketCreated(ticketCreated)ticketDeleted(ticketDeleted)ticketUpdated(ticketUpdated)
HTTP handler setup
app/api/webhook/route.ts
Events
Company Created
Company Created
companyCreated
A new company was created
Payload
| Name | Type | Required | Description |
|---|---|---|---|
subscriptionId | number | Yes | — |
portalId | number | Yes | — |
occurredAt | number | Yes | — |
subscriptionType | company.creation | Yes | — |
attemptNumber | number | Yes | — |
objectId | number | Yes | — |
propertyName | string | No | — |
propertyValue | string | No | — |
changeSource | string | No | — |
eventId | string | No | — |
Response data full type
Response data full type
webhookHooks example
Company Deleted
Company Deleted
companyDeleted
A company was deleted
Payload
| Name | Type | Required | Description |
|---|---|---|---|
subscriptionId | number | Yes | — |
portalId | number | Yes | — |
occurredAt | number | Yes | — |
subscriptionType | company.deletion | Yes | — |
attemptNumber | number | Yes | — |
objectId | number | Yes | — |
propertyName | string | No | — |
propertyValue | string | No | — |
changeSource | string | No | — |
eventId | string | No | — |
Response data full type
Response data full type
webhookHooks example
Company Updated
Company Updated
companyUpdated
A company property was updated
Payload
| Name | Type | Required | Description |
|---|---|---|---|
subscriptionId | number | Yes | — |
portalId | number | Yes | — |
occurredAt | number | Yes | — |
subscriptionType | company.propertyChange | Yes | — |
attemptNumber | number | Yes | — |
objectId | number | Yes | — |
propertyName | string | Yes | — |
propertyValue | string | Yes | — |
changeSource | string | No | — |
eventId | string | No | — |
Response data full type
Response data full type
webhookHooks example
Contact Created
Contact Created
contactCreated
A new contact was created
Payload
| Name | Type | Required | Description |
|---|---|---|---|
subscriptionId | number | Yes | — |
portalId | number | Yes | — |
occurredAt | number | Yes | — |
subscriptionType | contact.creation | Yes | — |
attemptNumber | number | Yes | — |
objectId | number | Yes | — |
propertyName | string | No | — |
propertyValue | string | No | — |
changeSource | string | No | — |
eventId | string | No | — |
Response data full type
Response data full type
webhookHooks example
Contact Deleted
Contact Deleted
contactDeleted
A contact was deleted
Payload
| Name | Type | Required | Description |
|---|---|---|---|
subscriptionId | number | Yes | — |
portalId | number | Yes | — |
occurredAt | number | Yes | — |
subscriptionType | contact.deletion | Yes | — |
attemptNumber | number | Yes | — |
objectId | number | Yes | — |
propertyName | string | No | — |
propertyValue | string | No | — |
changeSource | string | No | — |
eventId | string | No | — |
Response data full type
Response data full type
webhookHooks example
Contact Updated
Contact Updated
contactUpdated
A contact property was updated
Payload
| Name | Type | Required | Description |
|---|---|---|---|
subscriptionId | number | Yes | — |
portalId | number | Yes | — |
occurredAt | number | Yes | — |
subscriptionType | contact.propertyChange | Yes | — |
attemptNumber | number | Yes | — |
objectId | number | Yes | — |
propertyName | string | Yes | — |
propertyValue | string | Yes | — |
changeSource | string | No | — |
eventId | string | No | — |
Response data full type
Response data full type
webhookHooks example
Deal Created
Deal Created
dealCreated
A new deal was created
Payload
| Name | Type | Required | Description |
|---|---|---|---|
subscriptionId | number | Yes | — |
portalId | number | Yes | — |
occurredAt | number | Yes | — |
subscriptionType | deal.creation | Yes | — |
attemptNumber | number | Yes | — |
objectId | number | Yes | — |
propertyName | string | No | — |
propertyValue | string | No | — |
changeSource | string | No | — |
eventId | string | No | — |
Response data full type
Response data full type
webhookHooks example
Deal Deleted
Deal Deleted
dealDeleted
A deal was deleted
Payload
| Name | Type | Required | Description |
|---|---|---|---|
subscriptionId | number | Yes | — |
portalId | number | Yes | — |
occurredAt | number | Yes | — |
subscriptionType | deal.deletion | Yes | — |
attemptNumber | number | Yes | — |
objectId | number | Yes | — |
propertyName | string | No | — |
propertyValue | string | No | — |
changeSource | string | No | — |
eventId | string | No | — |
Response data full type
Response data full type
webhookHooks example
Deal Updated
Deal Updated
dealUpdated
A deal property was updated
Payload
| Name | Type | Required | Description |
|---|---|---|---|
subscriptionId | number | Yes | — |
portalId | number | Yes | — |
occurredAt | number | Yes | — |
subscriptionType | deal.propertyChange | Yes | — |
attemptNumber | number | Yes | — |
objectId | number | Yes | — |
propertyName | string | Yes | — |
propertyValue | string | Yes | — |
changeSource | string | No | — |
eventId | string | No | — |
Response data full type
Response data full type
webhookHooks example
Ticket Created
Ticket Created
ticketCreated
A new support ticket was created
Payload
| Name | Type | Required | Description |
|---|---|---|---|
subscriptionId | number | Yes | — |
portalId | number | Yes | — |
occurredAt | number | Yes | — |
subscriptionType | ticket.creation | Yes | — |
attemptNumber | number | Yes | — |
objectId | number | Yes | — |
propertyName | string | No | — |
propertyValue | string | No | — |
changeSource | string | No | — |
eventId | string | No | — |
Response data full type
Response data full type
webhookHooks example
Ticket Deleted
Ticket Deleted
ticketDeleted
A support ticket was deleted
Payload
| Name | Type | Required | Description |
|---|---|---|---|
subscriptionId | number | Yes | — |
portalId | number | Yes | — |
occurredAt | number | Yes | — |
subscriptionType | ticket.deletion | Yes | — |
attemptNumber | number | Yes | — |
objectId | number | Yes | — |
propertyName | string | No | — |
propertyValue | string | No | — |
changeSource | string | No | — |
eventId | string | No | — |
Response data full type
Response data full type
webhookHooks example
Ticket Updated
Ticket Updated
ticketUpdated
A support ticket property was updated
Payload
| Name | Type | Required | Description |
|---|---|---|---|
subscriptionId | number | Yes | — |
portalId | number | Yes | — |
occurredAt | number | Yes | — |
subscriptionType | ticket.propertyChange | Yes | — |
attemptNumber | number | Yes | — |
objectId | number | Yes | — |
propertyName | string | Yes | — |
propertyValue | string | Yes | — |
changeSource | string | No | — |
eventId | string | No | — |
Response data full type
Response data full type
webhookHooks example