Basic

Read an event subscription

Retrieve a specific event subscription by ID.

get/webhooks/v3/{appId}/subscriptions/{subscriptionId}

Path parameters

appIdinteger required

The ID of the target app.

subscriptionIdinteger required

The ID of the target subscription.

Response

successful operation

activeboolean required

Whether the subscription is active or paused. If true, the subscription will send webhook notifications. If false, the subscription is paused and will not send notifications.

createdAtstring date-time required

The timestamp when the webhook subscription was created, in ISO 8601 format (e.g., 2020-02-29T12:30:00Z).

eventType'company.associationChange' | 'company.creation' | 'company.deletion' | 'company.merge' | 'company.propertyChange' | 'company.restore' | 'contact.associationChange' | 'contact.creation' | 'contact.deletion' | 'contact.merge' | 'contact.privacyDeletion' | 'contact.propertyChange' | 'contact.restore' | 'conversation.creation' | 'conversation.deletion' | 'conversation.newMessage' | 'conversation.privacyDeletion' | 'conversation.propertyChange' | 'deal.associationChange' | 'deal.creation' | 'deal.deletion' | 'deal.merge' | 'deal.propertyChange' | 'deal.restore' | 'event.completed' | 'line_item.associationChange' | 'line_item.creation' | 'line_item.deletion' | 'line_item.merge' | 'line_item.propertyChange' | 'line_item.restore' | 'object.associationChange' | 'object.creation' | 'object.deletion' | 'object.merge' | 'object.propertyChange' | 'object.restore' | 'product.creation' | 'product.deletion' | 'product.merge' | 'product.propertyChange' | 'product.restore' | 'ticket.associationChange' | 'ticket.creation' | 'ticket.deletion' | 'ticket.merge' | 'ticket.propertyChange' | 'ticket.restore' required

The type of event to listen for. Accepted values include contact.creation, contact.deletion, contact.propertyChange, and similar event types for other CRM objects and custom objects.

eventTypeNamestring

The name of the event to listen for. This is used with custom objects to specify custom event types beyond the standard eventType enum values.

idstring required

The unique ID of the webhook subscription.

objectTypeIdstring

The ID of the object type for the subscription. This can be a standard CRM object (e.g., 'contact', 'company', 'deal') or a custom object ID for custom object subscriptions.

propertyNamestring

The internal name of the property to monitor for changes. Only applies when eventType is propertyChange.

updatedAtstring date-time

The timestamp when the webhook subscription was last updated, in ISO 8601 format (e.g., 2020-02-29T12:30:00Z).

Changes

Changed in 11 of the 56 revisions of this API.296112

    • the security scope developers-read was added to the endpoint's security scheme oauth2

      api-security-scope-added

    • the security scope private-apps-read was removed from the endpoint's security scheme oauth2

      api-security-scope-removed

    • endpoint added

      endpoint-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added

    This revision also has 23 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v31de03ff22d054850See the full diff
    • added the new company.associationChange enum value to the response property for the response status

      response-property-enum-value-added

    • added the new company.creation enum value to the response property for the response status

      response-property-enum-value-added

    • added the new company.deletion enum value to the response property for the response status

      response-property-enum-value-added

    • added the new company.merge enum value to the response property for the response status

      response-property-enum-value-added

    • added the new company.propertyChange enum value to the response property for the response status

      response-property-enum-value-added

    • added the new company.restore enum value to the response property for the response status

      response-property-enum-value-added

    • added the new contact.associationChange enum value to the response property for the response status

      response-property-enum-value-added

    • added the new contact.creation enum value to the response property for the response status

      response-property-enum-value-added

    • added the new contact.deletion enum value to the response property for the response status

      response-property-enum-value-added

    • added the new contact.merge enum value to the response property for the response status

      response-property-enum-value-added

    • added the new contact.privacyDeletion enum value to the response property for the response status

      response-property-enum-value-added

    • added the new contact.propertyChange enum value to the response property for the response status

      response-property-enum-value-added

    • added the new contact.restore enum value to the response property for the response status

      response-property-enum-value-added

    • added the new conversation.creation enum value to the response property for the response status

      response-property-enum-value-added

    • added the new conversation.deletion enum value to the response property for the response status

      response-property-enum-value-added

    • added the new conversation.newMessage enum value to the response property for the response status

      response-property-enum-value-added

    • added the new conversation.privacyDeletion enum value to the response property for the response status

      response-property-enum-value-added

    • added the new conversation.propertyChange enum value to the response property for the response status

      response-property-enum-value-added

    • added the new deal.associationChange enum value to the response property for the response status

      response-property-enum-value-added

    • added the new deal.creation enum value to the response property for the response status

      response-property-enum-value-added

    • added the new deal.deletion enum value to the response property for the response status

      response-property-enum-value-added

    • added the new deal.merge enum value to the response property for the response status

      response-property-enum-value-added

    • added the new deal.propertyChange enum value to the response property for the response status

      response-property-enum-value-added

    • added the new deal.restore enum value to the response property for the response status

      response-property-enum-value-added

    • added the new event.completed enum value to the response property for the response status

      response-property-enum-value-added

    • added the new line_item.associationChange enum value to the response property for the response status

      response-property-enum-value-added

    • added the new line_item.creation enum value to the response property for the response status

      response-property-enum-value-added

    • added the new line_item.deletion enum value to the response property for the response status

      response-property-enum-value-added

    • added the new line_item.merge enum value to the response property for the response status

      response-property-enum-value-added

    • added the new line_item.propertyChange enum value to the response property for the response status

      response-property-enum-value-added

    • added the new line_item.restore enum value to the response property for the response status

      response-property-enum-value-added

    • added the new object.associationChange enum value to the response property for the response status

      response-property-enum-value-added

    • added the new object.creation enum value to the response property for the response status

      response-property-enum-value-added

    • added the new object.deletion enum value to the response property for the response status

      response-property-enum-value-added

    • added the new object.merge enum value to the response property for the response status

      response-property-enum-value-added

    • added the new object.propertyChange enum value to the response property for the response status

      response-property-enum-value-added

    • added the new object.restore enum value to the response property for the response status

      response-property-enum-value-added

    • added the new product.creation enum value to the response property for the response status

      response-property-enum-value-added

    • added the new product.deletion enum value to the response property for the response status

      response-property-enum-value-added

    • added the new product.merge enum value to the response property for the response status

      response-property-enum-value-added

    • added the new product.propertyChange enum value to the response property for the response status

      response-property-enum-value-added

    • added the new product.restore enum value to the response property for the response status

      response-property-enum-value-added

    • added the new ticket.associationChange enum value to the response property for the response status

      response-property-enum-value-added

    • added the new ticket.creation enum value to the response property for the response status

      response-property-enum-value-added

    • added the new ticket.deletion enum value to the response property for the response status

      response-property-enum-value-added

    • added the new ticket.merge enum value to the response property for the response status

      response-property-enum-value-added

    • added the new ticket.propertyChange enum value to the response property for the response status

      response-property-enum-value-added

    • added the new ticket.restore enum value to the response property for the response status

      response-property-enum-value-added

    • the security scope developers-read was added to the endpoint's security scheme oauth2

      api-security-scope-added

    • the security scope private-apps-read was removed from the endpoint's security scheme oauth2

      api-security-scope-removed

    • removed the COMPANY_ASSOCIATION_CHANGE enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the COMPANY_CREATION enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the COMPANY_DELETION enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the COMPANY_MERGE enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the COMPANY_PROPERTY_CHANGE enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the COMPANY_RESTORE enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the CONTACT_ASSOCIATION_CHANGE enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the CONTACT_CREATION enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the CONTACT_DELETION enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the CONTACT_MERGE enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the CONTACT_PRIVACY_DELETION enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the CONTACT_PROPERTY_CHANGE enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the CONTACT_RESTORE enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the CONVERSATION_CREATION enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the CONVERSATION_DELETION enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the CONVERSATION_NEW_MESSAGE enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the CONVERSATION_PRIVACY_DELETION enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the CONVERSATION_PROPERTY_CHANGE enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the DEAL_ASSOCIATION_CHANGE enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the DEAL_CREATION enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the DEAL_DELETION enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the DEAL_MERGE enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the DEAL_PROPERTY_CHANGE enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the DEAL_RESTORE enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the LINE_ITEM_ASSOCIATION_CHANGE enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the LINE_ITEM_CREATION enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the LINE_ITEM_DELETION enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the LINE_ITEM_MERGE enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the LINE_ITEM_PROPERTY_CHANGE enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the LINE_ITEM_RESTORE enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the OBJECT_ASSOCIATION_CHANGE enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the OBJECT_CREATION enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the OBJECT_DELETION enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the OBJECT_MERGE enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the OBJECT_PROPERTY_CHANGE enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the OBJECT_RESTORE enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the PRODUCT_CREATION enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the PRODUCT_DELETION enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the PRODUCT_MERGE enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the PRODUCT_PROPERTY_CHANGE enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the PRODUCT_RESTORE enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the TICKET_ASSOCIATION_CHANGE enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the TICKET_CREATION enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the TICKET_DELETION enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the TICKET_MERGE enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the TICKET_PROPERTY_CHANGE enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the TICKET_RESTORE enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the UNIFIED_EVENT enum value from the response property for the response status

      response-property-enum-value-removed

  • v379cf1425dd5b4850See the full diff
    • added the new COMPANY_ASSOCIATION_CHANGE enum value to the response property for the response status

      response-property-enum-value-added

    • added the new COMPANY_CREATION enum value to the response property for the response status

      response-property-enum-value-added

    • added the new COMPANY_DELETION enum value to the response property for the response status

      response-property-enum-value-added

    • added the new COMPANY_MERGE enum value to the response property for the response status

      response-property-enum-value-added

    • added the new COMPANY_PROPERTY_CHANGE enum value to the response property for the response status

      response-property-enum-value-added

    • added the new COMPANY_RESTORE enum value to the response property for the response status

      response-property-enum-value-added

    • added the new CONTACT_ASSOCIATION_CHANGE enum value to the response property for the response status

      response-property-enum-value-added

    • added the new CONTACT_CREATION enum value to the response property for the response status

      response-property-enum-value-added

    • added the new CONTACT_DELETION enum value to the response property for the response status

      response-property-enum-value-added

    • added the new CONTACT_MERGE enum value to the response property for the response status

      response-property-enum-value-added

    • added the new CONTACT_PRIVACY_DELETION enum value to the response property for the response status

      response-property-enum-value-added

    • added the new CONTACT_PROPERTY_CHANGE enum value to the response property for the response status

      response-property-enum-value-added

    • added the new CONTACT_RESTORE enum value to the response property for the response status

      response-property-enum-value-added

    • added the new CONVERSATION_CREATION enum value to the response property for the response status

      response-property-enum-value-added

    • added the new CONVERSATION_DELETION enum value to the response property for the response status

      response-property-enum-value-added

    • added the new CONVERSATION_NEW_MESSAGE enum value to the response property for the response status

      response-property-enum-value-added

    • added the new CONVERSATION_PRIVACY_DELETION enum value to the response property for the response status

      response-property-enum-value-added

    • added the new CONVERSATION_PROPERTY_CHANGE enum value to the response property for the response status

      response-property-enum-value-added

    • added the new DEAL_ASSOCIATION_CHANGE enum value to the response property for the response status

      response-property-enum-value-added

    • added the new DEAL_CREATION enum value to the response property for the response status

      response-property-enum-value-added

    • added the new DEAL_DELETION enum value to the response property for the response status

      response-property-enum-value-added

    • added the new DEAL_MERGE enum value to the response property for the response status

      response-property-enum-value-added

    • added the new DEAL_PROPERTY_CHANGE enum value to the response property for the response status

      response-property-enum-value-added

    • added the new DEAL_RESTORE enum value to the response property for the response status

      response-property-enum-value-added

    • added the new LINE_ITEM_ASSOCIATION_CHANGE enum value to the response property for the response status

      response-property-enum-value-added

    • added the new LINE_ITEM_CREATION enum value to the response property for the response status

      response-property-enum-value-added

    • added the new LINE_ITEM_DELETION enum value to the response property for the response status

      response-property-enum-value-added

    • added the new LINE_ITEM_MERGE enum value to the response property for the response status

      response-property-enum-value-added

    • added the new LINE_ITEM_PROPERTY_CHANGE enum value to the response property for the response status

      response-property-enum-value-added

    • added the new LINE_ITEM_RESTORE enum value to the response property for the response status

      response-property-enum-value-added

    • added the new OBJECT_ASSOCIATION_CHANGE enum value to the response property for the response status

      response-property-enum-value-added

    • added the new OBJECT_CREATION enum value to the response property for the response status

      response-property-enum-value-added

    • added the new OBJECT_DELETION enum value to the response property for the response status

      response-property-enum-value-added

    • added the new OBJECT_MERGE enum value to the response property for the response status

      response-property-enum-value-added

    • added the new OBJECT_PROPERTY_CHANGE enum value to the response property for the response status

      response-property-enum-value-added

    • added the new OBJECT_RESTORE enum value to the response property for the response status

      response-property-enum-value-added

    • added the new PRODUCT_CREATION enum value to the response property for the response status

      response-property-enum-value-added

    • added the new PRODUCT_DELETION enum value to the response property for the response status

      response-property-enum-value-added

    • added the new PRODUCT_MERGE enum value to the response property for the response status

      response-property-enum-value-added

    • added the new PRODUCT_PROPERTY_CHANGE enum value to the response property for the response status

      response-property-enum-value-added

    • added the new PRODUCT_RESTORE enum value to the response property for the response status

      response-property-enum-value-added

    • added the new TICKET_ASSOCIATION_CHANGE enum value to the response property for the response status

      response-property-enum-value-added

    • added the new TICKET_CREATION enum value to the response property for the response status

      response-property-enum-value-added

    • added the new TICKET_DELETION enum value to the response property for the response status

      response-property-enum-value-added

    • added the new TICKET_MERGE enum value to the response property for the response status

      response-property-enum-value-added

    • added the new TICKET_PROPERTY_CHANGE enum value to the response property for the response status

      response-property-enum-value-added

    • added the new TICKET_RESTORE enum value to the response property for the response status

      response-property-enum-value-added

    • added the new UNIFIED_EVENT enum value to the response property for the response status

      response-property-enum-value-added

    • the security scope developers-read was added to the endpoint's security scheme oauth2

      api-security-scope-added

    • the security scope private-apps-read was removed from the endpoint's security scheme oauth2

      api-security-scope-removed

    • removed the company.associationChange enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the company.creation enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the company.deletion enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the company.merge enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the company.propertyChange enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the company.restore enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the contact.associationChange enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the contact.creation enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the contact.deletion enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the contact.merge enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the contact.privacyDeletion enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the contact.propertyChange enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the contact.restore enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the conversation.creation enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the conversation.deletion enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the conversation.newMessage enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the conversation.privacyDeletion enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the conversation.propertyChange enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the deal.associationChange enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the deal.creation enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the deal.deletion enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the deal.merge enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the deal.propertyChange enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the deal.restore enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the event.completed enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the line_item.associationChange enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the line_item.creation enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the line_item.deletion enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the line_item.merge enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the line_item.propertyChange enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the line_item.restore enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the object.associationChange enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the object.creation enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the object.deletion enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the object.merge enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the object.propertyChange enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the object.restore enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the product.creation enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the product.deletion enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the product.merge enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the product.propertyChange enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the product.restore enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the ticket.associationChange enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the ticket.creation enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the ticket.deletion enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the ticket.merge enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the ticket.propertyChange enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the ticket.restore enum value from the response property for the response status

      response-property-enum-value-removed

    • the security scope developers-read was added to the endpoint's security scheme oauth2

      api-security-scope-added

    • the security scope private-apps-read was removed from the endpoint's security scheme oauth2

      api-security-scope-removed

    • the security scope private-apps-read was removed from the endpoint's security scheme oauth2

      api-security-scope-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the endpoint scheme security app_cookie was removed from the API

      api-security-removed

    • the endpoint scheme security developer_hapikey was removed from the API

      api-security-removed

    • the endpoint scheme security internal_cookie was removed from the API

      api-security-removed

    • the endpoint scheme security shhkey was removed from the API

      api-security-removed