Ler assinaturas de evento

curl --request GET \
  --url 'https://api.hubapi.com/webhooks/v3/{appId}/subscriptions?hapikey='

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

GET

webhooks

{appId}

subscriptions

Ler assinaturas de evento

curl --request GET \
  --url 'https://api.hubapi.com/webhooks/v3/{appId}/subscriptions?hapikey='

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

Produtos suportados

Requer um dos seguintes produtos ou superior.

Marketing HubProfessional

Sales HubProfessional

Service HubProfessional

Content HubStarter

Authorizations

hapikey

string

query

required

Path Parameters

appId

integer<int32>

required

O ID do aplicativo.

Response

successful operation

List of event subscriptions for your app

results

object[]

required

Lista de assinaturas de eventos para seu aplicativo

Anzeigen untergeordnete attribute

results.active

boolean

required

Determina se a assinatura está ativa ou pausada.

results.createdAt

string<date-time>

required

Quando esta assinatura foi criada. Formatado como milissegundos a partir de era Unix.

results.eventType

enum<string>

required

O tipo de evento a ser monitorado. Pode ser "create", "delete", "deletedForPrivacy" ou "propertyChange".

Verfügbare Optionen:

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,

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

results.id

string

required

O ID exclusivo da assinatura.

results.objectTypeId

string

O identificador do tipo de objeto associado à assinatura.

results.propertyName

string

O nome interno da propriedade que está sendo monitorada quanto a alterações. Somente se aplica quando "eventType" é "propertyChange".

results.updatedAt

string<date-time>

Quando esta assinatura foi atualizada pela última vez. Formatado como milissegundos a partir de era Unix.

API dos Webhooks

Zurück

Criar uma assinatura de evento

Weiter

⌘I

Webhooks v4

Webhooks v3

Ler assinaturas de evento

Authorizations

Path Parameters

Response