Get /webhooks/v3/{app Id}/subscriptions/{subscription Id} Get By Id

Read an event subscription

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

Use it in a workflow

Add a step and choose the HubSpot connector.
Pick the Get /webhooks/v3/{app Id}/subscriptions/{subscription Id} Get By Id action (under Webhooks).
Fill in the fields below, then reference the result from later steps as {{getWebhooksV3AppIdSubscriptionsSubscriptionIdGetById.response.data}}.

Request

Path parameters

appIdinteger (int32)required

The ID of the target app.

subscriptionIdinteger (int32)required

The ID of the target subscription.

Response

Returns 200 with an object. Read it in later steps with {{getWebhooksV3AppIdSubscriptionsSubscriptionIdGetById.response.data.<field>}}.

activeboolean

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)

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

eventTypestring

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.

One ofcompany.associationChangecompany.creationcompany.deletioncompany.mergecompany.propertyChangecompany.restorecontact.associationChangecontact.creationcontact.deletioncontact.mergecontact.privacyDeletioncontact.propertyChangecontact.restoreconversation.creationconversation.deletionconversation.newMessageconversation.privacyDeletionconversation.propertyChangedeal.associationChangedeal.creationdeal.deletiondeal.mergedeal.propertyChangedeal.restoreevent.completedline_item.associationChangeline_item.creationline_item.deletionline_item.mergeline_item.propertyChangeline_item.restoreobject.associationChangeobject.creationobject.deletionobject.mergeobject.propertyChangeobject.restoreproduct.creationproduct.deletionproduct.merge

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

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).

json

{
  "active": false,
  "createdAt": "2025-01-01T00:00:00Z",
  "eventType": "company.associationChange",
  "id": "string",
  "eventTypeName": "string",
  "objectTypeId": "string",
  "propertyName": "string",
  "updatedAt": "2025-01-01T00:00:00Z"
}

Need more? See the HubSpot guide for connection setup and behaviour shared by every action.

Was this page helpful?