Basic

Changed on
post/app-webhooks/2027-03-beta/{appId}/subscriptions

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/app-webhooks/2027-03-beta/{appId}/subscriptions
  • Auth
    API key in query parameter hapikey

Path parameters

appIdinteger required

Request body

activeboolean required

A boolean indicating whether the subscription is active.

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

A string representing the type of event to subscribe to. Valid values include various property changes, creations, deletions, merges, restorations, association changes, and event completions.

eventTypeNamestring

A string providing a human-readable name for the event type.

objectTypeIdstring

A string representing the ID of the object type associated with the subscription.

propertyNamestring

A string indicating the specific property name related to the event type, if applicable.

Response

successful operation

activeboolean required

A boolean indicating whether the subscription is currently active.

createdAtstring date-time required

The date and time when the subscription was created, in ISO 8601 format.

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 that triggers the subscription. Valid values include various property changes, creations, deletions, merges, restores, and association changes for different HubSpot objects.

eventTypeNamestring

The name of the event type for the subscription.

idstring required

The unique identifier for the subscription. It is an integer formatted as int64.

objectTypeIdstring

The identifier for the object type associated with the subscription. It is a string.

propertyNamestring

The name of the property associated with the subscription event, if applicable.

updatedAtstring date-time

The date and time when the subscription was last updated, in ISO 8601 format.

Changes

  • 2027-03-beta6995629a4549Revision changes
    • info

      the endpoint scheme security developer_hapikey was added to the API

    • info

      the endpoint scheme security oauth2 was removed from the API

    • info

      the endpoint scheme security oauth2 was removed from the API

  • 2027-03-beta14f87d33fd3aRevision changes
    • info

      api operation id post-/app-webhooks/2027-03-beta/{appId}/subscriptions removed and replaced with post-/app-webhooks/2027-03-beta/{appId}/subscriptions_/app-webhooks/2027-03-beta/{appId}/subscriptions

    • info

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

    • info

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