Eventos de webhook do Partner CenterPartner Center webhook events

Aplica-se aApplies To

  • Partner CenterPartner Center
  • Partner Center operado pela 21VianetPartner Center operated by 21Vianet
  • Partner Center do Microsoft Cloud GermanyPartner Center for Microsoft Cloud Germany
  • Partner Center do Microsoft Cloud for US GovernmentPartner Center for Microsoft Cloud for US Government

Os eventos de webhook do Partner Center são eventos de alteração de recursos entregues na forma de postagens HTTP para uma URL registrada.Partner Center webhook events are resource change events delivered in the form of HTTP POSTs to a registered URL. Para receber um evento do Partner Center, você hospeda um retorno de chamada em que o Partner Center pode postar o evento.To receive an event from Partner Center, you host a callback where Partner Center can POST the event. O evento é assinado digitalmente para que você possa validar que ele foi enviado do Partner Center.The event is digitally signed so you can validate that it was sent from Partner Center.

Para obter informações sobre como receber eventos, autenticar um retorno de chamada e usar as APIs de webhook do Partner Center para criar, exibir e atualizar um registro de evento, consulte WebHooks do Partner Center.For information on how to receive events, authenticate a callback, and use the Partner Center webhook APIs to create, view, and update an event registration, see Partner Center Webhooks.

Eventos com suporteSupported Events

Os seguintes eventos de webhook têm suporte do Partner Center.The following webhook events are supported by Partner Center.

Evento de testeTest Event

Esse evento permite que você se integre automaticamente e teste seu registro solicitando um evento de teste e, em seguida, acompanhando seu progresso.This event allows you to self-onboard and test your registration by requesting a test event and then tracking its progress. Você poderá ver as mensagens de falha que estão sendo recebidas da Microsoft ao tentar entregar o evento.You will be able to see the failure messages that are being received from Microsoft while trying to deliver the event. Isso só se aplicará a eventos "criados pelo teste" e os dados com mais de 7 dias serão limpos.This will only apply to "test-created" events and data older than 7 days will be purged.

Observação

Há um limite de limitação de 2 solicitações por minuto ao lançar um evento de teste criado.There is a throttle limit of 2 requests per minute when posting a test-created event.

PropriedadesProperties

PropriedadeProperty TipoType DescriçãoDescription
EventNameEventName stringstring O nome do evento.The name of the event. No formato {Resource}-{Action}.In the form {resource}-{action}. Para esse evento, o valor é "criado pelo teste".For this event, the value is "test-created".
ResourceUriResourceUri URIURI O URI para obter o recurso.The URI to get the resource. Usa a sintaxe: "{baseURL}/WebHooks/v1/Registration/validationEvents/{{CorrelationId}}"Uses the syntax: "{baseURL}/webhooks/v1/registration/validationEvents/{{CorrelationId}}"
ResourceNameResourceName stringstring O nome do recurso que irá disparar o evento.The name of the resource that will trigger the event. Para esse evento, o valor é "Test".For this event, the value is "test".
AuditUriAuditUri URIURI Adicional O URI para obter o registro de auditoria, se ele existir.(Optional) The URI to get the audit record, if it exists. Usa a sintaxe: "{baseURL}/auditactivity/v1/AuditRecords/{{AuditId}}"Uses the syntax: "{baseURL}/auditactivity/v1/auditrecords/{{AuditId}}"
ResourceChangeUtcDateResourceChangeUtcDate Cadeia de caracteres no formato de data/hora UTCstring in the UTC date-time format A data e a hora em que a alteração do recurso ocorreu.The date and time when the resource change occurred.

ExemploExample

{
    "EventName": "test-created",
    "ResourceUri": "http://api.partnercenter.microsoft.com/webhooks/v1/registration/validationEvents/{{CorrelationId}}",
    "ResourceName": "test",
    "AuditUri": null,
    "ResourceChangeUtcDate": "2017-11-16T16:19:06.3520276+00:00"
}

Evento de atualização de assinaturaSubscription Updated Event

Esse evento é gerado quando a assinatura especificada é alterada.This event is raised when the specified subscription changes. Um evento de assinatura atualizado é gerado quando há uma alteração interna além de quando as alterações são feitas por meio da API do Partner Center.A Subscription Updated event is generated when there is an internal change in addition to when changes are made through the Partner Center API. Esse evento será gerado somente quando houver alterações no nível de comércio, por exemplo, quando o número de licenças for modificado e quando o estado da assinatura for alterado.This event will be only be generated when there are commerce level changes, for example, when the number of licenses are modified and when the state of the subscription changes. Ele não será gerado quando os recursos forem criados na assinatura.It will not be generated when resources are created within the subscription.

Observação

Há um atraso de até 48 horas entre o tempo em que uma assinatura é alterada e o evento de atualização de assinatura é disparado.There is a delay of up to 48 hours between the time a subscription changes and when the Subscription Updated event is triggered.

PropriedadesProperties

PropriedadeProperty TipoType DescriçãoDescription
EventNameEventName stringstring O nome do evento.The name of the event. No formato {Resource}-{Action}.In the form {resource}-{action}. Para esse evento, o valor é "assinatura-atualizado".For this event, the value is "subscription-updated".
ResourceUriResourceUri URIURI O URI para obter o recurso.The URI to get the resource. Usa a sintaxe: "{baseURL}/WebHooks/v1/Customers/{{CustomerID}}/subscriptions/{{SubscriptionId}}"Uses the syntax: "{baseURL}/webhooks/v1/customers/{{CustomerId}}/subscriptions/{{SubscriptionId}}"
ResourceNameResourceName stringstring O nome do recurso que irá disparar o evento.The name of the resource that will trigger the event. Para esse evento, o valor é "Subscription".For this event, the value is "subscription".
AuditUriAuditUri URIURI Adicional O URI para obter o registro de auditoria, se ele existir.(Optional) The URI to get the audit record, if it exists. Usa a sintaxe: "{baseURL}/auditactivity/v1/AuditRecords/{{AuditId}}"Uses the syntax: "{baseURL}/auditactivity/v1/auditrecords/{{AuditId}}"
ResourceChangeUtcDateResourceChangeUtcDate Cadeia de caracteres no formato de data/hora UTCstring in the UTC date-time format A data e a hora em que a alteração do recurso ocorreu.The date and time when the resource change occurred.

ExemploExample

{
    "EventName": "subscription-updated",
    "ResourceUri": "http://api.partnercenter.microsoft.com/webhooks/v1/customers/{{CustomerId}}/subscriptions/{{SubscriptionId}}",
    "ResourceName": "subscription",
    "AuditUri": "https://api.partnercenter.microsoft.com/v1/auditrecords/{{AuditId}}",
    "ResourceChangeUtcDate": "2017-11-16T16:19:06.3520276+00:00"
}

Evento de limite excedidoThreshold Exceeded Event

Esse evento é gerado quando a quantidade de Microsoft Azure uso de qualquer cliente excede seu orçamento de gastos de uso (seu limite).This event is raised when the amount of Microsoft Azure usage for any customer exceeds their usage spending budget (their threshold). Para obter mais informações, consulte [definir um orçamento de gastos do Azure para seus clientes/Partner-Center/set-a-Azure-rependetion-Budget-for-your-Customers).For more information, see [Set an Azure spending budget for your customers/partner-center/set-an-azure-spending-budget-for-your-customers).

PropriedadesProperties

PropriedadeProperty TipoType DescriçãoDescription
EventNameEventName stringstring O nome do evento.The name of the event. No formato {Resource}-{Action}.In the form {resource}-{action}. Para esse evento, o valor é "usagerecords-thresholdExceeded".For this event, the value is "usagerecords-thresholdExceeded".
ResourceUriResourceUri URIURI O URI para obter o recurso.The URI to get the resource. Usa a sintaxe: "{baseURL}/WebHooks/v1/Customers/usagerecords"Uses the syntax: "{baseURL}/webhooks/v1/customers/usagerecords"
ResourceNameResourceName stringstring O nome do recurso que irá disparar o evento.The name of the resource that will trigger the event. Para esse evento, o valor é "usagerecords".For this event, the value is "usagerecords".
AuditUriAuditUri URIURI Adicional O URI para obter o registro de auditoria, se ele existir.(Optional) The URI to get the audit record, if it exists. Usa a sintaxe: "{baseURL}/auditactivity/v1/AuditRecords/{{AuditId}}"Uses the syntax: "{baseURL}/auditactivity/v1/auditrecords/{{AuditId}}"
ResourceChangeUtcDateResourceChangeUtcDate Cadeia de caracteres no formato de data/hora UTCstring in the UTC date-time format A data e a hora em que a alteração do recurso ocorreu.The date and time when the resource change occurred.

ExemploExample

{
    "EventName": "usagerecords-thresholdExceeded",
    "ResourceUri": "https://api.partnercenter.microsoft.com/v1/customers/usagerecords",
    "ResourceName": "usagerecords",
    "AuditUri": null,
    "ResourceChangeUtcDate": "2018-02-17T00:05:39.5485487+00:00"
}

Evento de referência criadoReferral Created Event

Esse evento é gerado quando a referência é criada.This event is raised when the referral is created.

PropriedadesProperties

PropriedadeProperty TipoType DescriçãoDescription
EventNameEventName stringstring O nome do evento.The name of the event. No formato {Resource}-{Action}.In the form {resource}-{action}. Para esse evento, o valor é "referência criada".For this event, the value is "referral-created".
ResourceUriResourceUri URIURI O URI para obter o recurso.The URI to get the resource. Usa a sintaxe: "{baseURL}/engagements/v1/referrals/{{ReferralID}}"Uses the syntax: "{baseURL}/engagements/v1/referrals/{{ReferralID}}"
ResourceNameResourceName stringstring O nome do recurso que irá disparar o evento.The name of the resource that will trigger the event. Para esse evento, o valor é "referência".For this event, the value is "referral".
AuditUriAuditUri URIURI Adicional O URI para obter o registro de auditoria, se ele existir.(Optional) The URI to get the audit record, if it exists. Usa a sintaxe: "{baseURL}/auditactivity/v1/AuditRecords/{{AuditId}}"Uses the syntax: "{baseURL}/auditactivity/v1/auditrecords/{{AuditId}}"
ResourceChangeUtcDateResourceChangeUtcDate Cadeia de caracteres no formato de data/hora UTCstring in the UTC date-time format A data e a hora em que a alteração do recurso ocorreu.The date and time when the resource change occurred.

ExemploExample

{
    "EventName": "referral-created",
    "ResourceUri": "https://api.partnercenter.microsoft.com/engagements/v1/referrals/{{ReferralID}}",
    "ResourceName": "referral",
    "AuditUri": null,
    "ResourceChangeUtcDate": "2018-02-17T00:05:39.5485487+00:00"
}

Evento de atualização de referênciaReferral Updated Event

Esse evento é gerado quando a referência é atualizada.This event is raised when the referral is updated.

PropriedadesProperties

PropriedadeProperty TipoType DescriçãoDescription
EventNameEventName stringstring O nome do evento.The name of the event. No formato {Resource}-{Action}.In the form {resource}-{action}. Para esse evento, o valor é "referência-atualizado".For this event, the value is "referral-updated".
ResourceUriResourceUri URIURI O URI para obter o recurso.The URI to get the resource. Usa a sintaxe: "{baseURL}/engagements/v1/referrals/{{ReferralID}}"Uses the syntax: "{baseURL}/engagements/v1/referrals/{{ReferralID}}"
ResourceNameResourceName stringstring O nome do recurso que irá disparar o evento.The name of the resource that will trigger the event. Para esse evento, o valor é "referência".For this event, the value is "referral".
AuditUriAuditUri URIURI Adicional O URI para obter o registro de auditoria, se ele existir.(Optional) The URI to get the audit record, if it exists. Usa a sintaxe: "{baseURL}/auditactivity/v1/AuditRecords/{{AuditId}}"Uses the syntax: "{baseURL}/auditactivity/v1/auditrecords/{{AuditId}}"
ResourceChangeUtcDateResourceChangeUtcDate Cadeia de caracteres no formato de data/hora UTCstring in the UTC date-time format A data e a hora em que a alteração do recurso ocorreu.The date and time when the resource change occurred.

ExemploExample

{
    "EventName": "referral-updated",
    "ResourceUri": "https://api.partnercenter.microsoft.com/engagements/v1/referrals/{{ReferralID}}",
    "ResourceName": "referral",
    "AuditUri": null,
    "ResourceChangeUtcDate": "2018-02-17T00:05:39.5485487+00:00"
}

Evento de nota fiscal prontaInvoice Ready Event

Esse evento é gerado quando a nova fatura está pronta.This event is raised when the new invoice is ready.

PropriedadeProperty TipoType DescriçãoDescription
EventNameEventName stringstring O nome do evento.The name of the event. No formato {Resource}-{Action}.In the form {resource}-{action}. Para esse evento, o valor é "pronto para a nota fiscal".For this event, the value is "invoice-ready".
ResourceUriResourceUri URIURI O URI para obter o recurso.The URI to get the resource. Usa a sintaxe: "{baseURL}/v1/invoices/{{InvoiceId}}"Uses the syntax: "{baseURL}/v1/invoices/{{InvoiceId}}"
ResourceNameResourceName stringstring O nome do recurso que irá disparar o evento.The name of the resource that will trigger the event. Para esse evento, o valor é "fatura".For this event, the value is "invoice".
AuditUriAuditUri URIURI Adicional O URI para obter o registro de auditoria, se ele existir.(Optional) The URI to get the audit record, if it exists. Usa a sintaxe: "{baseURL}/auditactivity/v1/AuditRecords/{{AuditId}}")Uses the syntax: "{baseURL}/auditactivity/v1/auditrecords/{{AuditId}}")
ResourceChangeUtcDateResourceChangeUtcDate Cadeia de caracteres no formato de data/hora UTCstring in the UTC date-time format A data e a hora em que a alteração do recurso ocorreu.The date and time when the resource change occurred.

ExemploExample

{
    "EventName": "invoice-ready",
    "ResourceUri": "https://api.partnercenter.microsoft.com/v1/invoices/{{InvoiceId}}",
    "ResourceName": "invoice",
    "AuditUri": null,
    "ResourceChangeUtcDate": "2018-02-17T00:05:39.5485487+00:00"
}