Post /webhooks/v3/{app Id}/subscriptions/batch/update Update Batch

Batch create event subscriptions

POST/webhooks/v3/{appId}/subscriptions/batch/update

Use it in a workflow

Add a step and choose the HubSpot connector.
Pick the Post /webhooks/v3/{app Id}/subscriptions/batch/update Update Batch action (under Webhooks).
Fill in the fields below, then reference the result from later steps as {{postWebhooksV3AppIdSubscriptionsBatchUpdateUpdateBatch.response.data}}.

Request

Path parameters

appIdinteger (int32)required

The ID of the target app.

Request body

Enter the body as JSON in the step's Body field.

inputsarray<object>required

An array of SubscriptionBatchUpdateRequest objects, each representing the updated settings for a specific webhook subscription in the batch operation.

activebooleanrequired

Whether to activate or pause the webhook subscription. If true, the subscription will send webhook notifications. If false, the subscription is paused and will not send notifications. It is a boolean.

idinteger (int32)required

The ID of the webhook subscription to update. It is an integer.

json

{
  "inputs": [
    {
      "active": true,
      "id": 12
    }
  ]
}

Response

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

completedAtstring (date-time)

The timestamp when the batch operation completed, in ISO 8601 format.

linksobject

An object containing URLs for related resources or operations.

requestedAtstring (date-time)

The timestamp when the batch operation was requested, in ISO 8601 format.

resultsarray<object>

An array containing the successfully processed webhook subscriptions from the batch operation.

activebooleanrequired

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

eventTypestringrequired

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.

idstringrequired

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

startedAtstring (date-time)

The timestamp when the batch operation started processing, in ISO 8601 format.

statusstring

The status of the batch operation. Accepted values are 'PENDING', 'PROCESSING', 'CANCELED', or 'COMPLETE'.

One ofCANCELEDCOMPLETEPENDINGPROCESSING

json

{
  "completedAt": "2025-01-01T00:00:00Z",
  "results": [
    {
      "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"
    }
  ],
  "startedAt": "2025-01-01T00:00:00Z",
  "status": "CANCELED",
  "links": {},
  "requestedAt": "2025-01-01T00:00:00Z"
}

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

Was this page helpful?