Update an event subscription

Atualize uma assinatura de evento existente por ID.

PATCH /webhooks/2026-03/{appId}/subscriptions/{subscriptionId}

Atualizar uma assinatura de evento

cURL

curl --request PATCH \
  --url https://api.hubapi.com/webhooks/2026-03/{appId}/subscriptions/{subscriptionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "active": true
}'

200

{
  "active": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "eventType": "company.associationChange",
  "id": "<string>",
  "eventTypeName": "<string>",
  "objectTypeId": "<string>",
  "propertyName": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Supported products

Autorizações

Authorization · string · header · obrigatório

The access token received from the authorization server in the OAuth 2.0 flow.

Parâmetros de caminho

appId · integer<int32> · obrigatório

O ID do aplicativo de destino.

subscriptionId · integer<int32> · obrigatório

O ID da assinatura para atualizar.

Corpo

application/json

active · boolean

Indica se a assinatura do webhook deve ser ativada ou pausada. Se for "true", a assinatura enviará notificações de webhook. Se for "false", a assinatura será pausada e não enviará notificações.

Resposta

200

application/json

successful operation

active · boolean · obrigatório

Indica se a assinatura está ativa ou pausada. Se for "true", a assinatura enviará notificações de webhook. Se for "false", a assinatura será pausada e não enviará notificações.

createdAt · string<date-time> · obrigatório

A data/hora em que a assinatura do webhook foi criada, no formato ISO 8601 (por exemplo, 2020-02-29T12:30:00Z).

eventType · enum<string> · obrigatório

O tipo de evento a ser monitorado. Os valores aceitos incluem contact.creation, contact.deletion, contact.propertyChange e tipos de eventos semelhantes para outros objetos do CRM e objetos personalizados.

Opções disponíveis: 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

id · string · obrigatório

O ID exclusivo da assinatura do webhook.

eventTypeName · string

O nome do evento a ser monitorado. Isso é usado com objetos personalizados para especificar tipos de eventos personalizados além dos valores padrão de enumeração eventType.

objectTypeId · string

O ID do objeto para a assinatura. Pode ser um objeto dp CRM padrão (por exemplo, "contato", "registro de empresa", "negócio") ou um ID de objeto personalizado para assinaturas de objetos personalizados.

propertyName · string

O nome interno da propriedade a ser monitorada quanto a alterações. Somente se aplica quando eventType é propertyChange.

updatedAt · string<date-time>

A data/hora da última atualização da assinatura do webhook, no formato ISO 8601 (por exemplo, 2020-02-29T12:30:00Z).