Webhooks
Eventos

Eventos

Introdução

Por padrão, o Byma dispara Webhooks quando eventos (ações) distintos acontecem dentro nos eventos (lojas) selecionados.

Os eventos são divididos entre os tipos de objeto (ingresso, venda) e o tipo da ação (criação, atualização).

Lista de eventos

Venda criada

Descrição

Disparado na criação de uma fatura no sistema.

Atributos

AtributoValorObservação
eventNameChave (nome) do eventoSerá sempre order.created
order.statusStatus da vendaConsulte a lista de status possíveis
order.createdAtHorario de criação em formato ISO 8601
order.tokenIdentificador da fatura
order.ticketCountTotal de ingressos gerados nessa fatura
order.eventIdID do Evento no Byma
order.paymentMethodMétodo de pagamento utilizado na vendaConsulte a lista de métodos possíveis. Parâmetro opcional, em alguns casos será preenchido em atualização posterior.
order.paymentInstallmentsNúmero de parcelas, quando aplicávelParâmetro opcional, em alguns casos será preenchido em atualização posterior.
order.orderAmountCentsSomatório do valor dos ingressos dentro da vendaParâmetro opcional, em alguns casos será preenchido em atualização posterior.
order.totalAmountCentsValor total pago na venda, incluindo taxasParâmetro opcional, em alguns casos será preenchido em atualização posterior.
order.producerAmountCentsValor total pago em taxas pelo produtorParâmetro opcional, em alguns casos será preenchido em atualização posterior.
order.customerAmountCentsValor total pago em taxas pelo consumidorParâmetro opcional, em alguns casos será preenchido em atualização posterior.
order.userData.nameNome do usuário criado no BymaParâmetro opcional, em alguns casos será preenchido em atualização posterior.
order.userData.emailEmail do usuário criado no BymaParâmetro opcional, em alguns casos será preenchido em atualização posterior.
order.userData.phoneTelefone do usuário criado no BymaParâmetro opcional, em alguns casos será preenchido em atualização posterior.
order.userData.cpfCPF do usuário criado no BymaParâmetro opcional, em alguns casos será preenchido em atualização posterior.
order.utmParams.utm_sourceParâmetro UTM
order.utmParams.utm_mediumParâmetro UTM
order.utmParams.utm_campaignParâmetro UTM
order.utmParams.utm_termParâmetro UTM
order.utmParams.utm_contentParâmetro UTM

Exemplo

{
  "eventName": "order.created",
  "order": {
    "_id": "64529734e1146d00086fc685",
    "status": "paid",
    "createdAt": "2023-05-03T17:17:40.912Z",
    "token": "123456abc",
    "ticketCount": 1,
    "eventId": "xyz98765",
    "paymentMethod": "free",
    "paymentInstallments": 1,
    "orderAmountCents": 0,
    "totalAmountCents": 0,
    "producerAmountCents": 0,
    "customerAmountCents": 0,
    "userData": {
      "name": "João Maria Da Silva",
      "email": "joao@exemplo.com",
      "cpf": "123456789-00",
      "phone": "123456789"
    },
    "utmParams": {
        "utm_source": "test",
        "utm_medium": "test",
        "utm_campaign": "test",
        "utm_term": "test",
        "utm_content": "test"
    }
  }
}

Venda atualizada

Descrição

Disparado na atualização de uma fatura no sistema.

Atributos

AtributoValorObservação
eventNameChave (nome) do eventoSerá sempre order.updated
order.statusStatus da vendaConsulte a lista de status possíveis
order.createdAtHorario de criação em formato ISO 8601
order.tokenIdentificador da fatura
order.ticketCountTotal de ingressos gerados nessa fatura
order.eventIdID do Evento no Byma
order.paymentMethodMétodo de pagamento utilizado na vendaConsulte a lista de métodos possíveis. Parâmetro opcional, em alguns casos será preenchido em atualização posterior.
order.paymentInstallmentsNúmero de parcelas, quando aplicávelParâmetro opcional, em alguns casos será preenchido em atualização posterior.
order.orderAmountCentsSomatório do valor dos ingressos dentro da vendaParâmetro opcional, em alguns casos será preenchido em atualização posterior.
order.totalAmountCentsValor total pago na venda, incluindo taxasParâmetro opcional, em alguns casos será preenchido em atualização posterior.
order.producerAmountCentsValor total pago em taxas pelo produtorParâmetro opcional, em alguns casos será preenchido em atualização posterior.
order.customerAmountCentsValor total pago em taxas pelo consumidorParâmetro opcional, em alguns casos será preenchido em atualização posterior.
order.userData.nameNome do usuário criado no BymaParâmetro opcional, em alguns casos será preenchido em atualização posterior.
order.userData.emailEmail do usuário criado no BymaParâmetro opcional, em alguns casos será preenchido em atualização posterior.
order.userData.phoneTelefone do usuário criado no BymaParâmetro opcional, em alguns casos será preenchido em atualização posterior.
order.userData.cpfCPF do usuário criado no BymaParâmetro opcional, em alguns casos será preenchido em atualização posterior.
order.utmParams.utm_sourceParâmetro UTM
order.utmParams.utm_mediumParâmetro UTM
order.utmParams.utm_campaignParâmetro UTM
order.utmParams.utm_termParâmetro UTM
order.utmParams.utm_contentParâmetro UTM

Exemplo

{
  "eventName": "order.updated",
  "order": {
    "_id": "64529734e1146d00086fc685",
    "status": "paid",
    "createdAt": "2023-05-03T17:17:40.912Z",
    "token": "123456abc",
    "ticketCount": 1,
    "eventId": "xyz98765",
    "paymentMethod": "free",
    "paymentInstallments": 1,
    "orderAmountCents": 0,
    "totalAmountCents": 0,
    "producerAmountCents": 0,
    "customerAmountCents": 0,
    "userData": {
      "name": "João Maria Da Silva",
      "email": "joao@exemplo.com",
      "cpf": "123456789-00",
      "phone": "123456789"
    },
    "utm_params": {
        "utm_source": "test",
        "utm_medium": "test",
        "utm_campaign": "test",
        "utm_term": "test",
        "utm_content": "test"
    }
  }
}

Ingresso criado

Descrição

Disparado na criação de um ingresso no sistema.

Atributos

AtributoValorObservação
eventNameChave (nome) do eventoSerá sempre ticket.created
ticket._idID do ingresso
ticket.guestNameNome do titular do ingresso
ticket.guestIdDocumento do titular do ingresso
ticket.statusStatus do ingressoConsulte a lista de status possíveis
ticket.createdAtHorario de criação em formato ISO 8601
ticket.ticketTypeIdID do lote de ingressos
ticket.ticketTypeNameNome do lote de ingressos
ticket.ticketTypePriceValor unitário do lote do ingresso, em centavos
ticket.eventIdID do Evento no Byma

Exemplo

{
  "eventName": "ticket.created",
  "ticket": {
    "_id": "123",
    "guestName": "João Maria",
    "guestId": "123.456.789-00",
    "status": "paid",
    "createdAt": "2023-05-03T17:17:40.874Z",
    "ticketTypeId": "456",
    "ticketTypeName": "Primeiro Lote",
    "ticketTypePrice": "100",
    "eventId": "xyz98765"
  }
}

Carrinho criado

Descrição

Disparado na criação de um carrinho no sistema.

Atributos

AtributoValorObservação
eventNameChave (nome) do eventoSerá sempre shoppingcart.created
shoppingcart._idID do carrinho
shoppingcart.statusStatus do carrinhopending, paid ou expired
shoppingcart.createdAtHorario de criação em formato ISO 8601
shoppingcart.expiresAtHorario de expiração em formato ISO 8601
shoppingcart.ticketCountHorario de expiração em formato ISO 8601
shoppingcart.eventIdID do Evento no Byma
shoppingcart.contentsArray de objetos
shoppingCart.utmParams.utm_sourceParâmetro UTM
shoppingCart.utmParams.utm_mediumParâmetro UTM
shoppingCart.utmParams.utm_campaignParâmetro UTM
shoppingCart.utmParams.utm_termParâmetro UTM
shoppingCart.utmParams.utm_contentParâmetro UTM
shoppingCart.userData.nameNome do usuário criado no BymaParâmetro opcional, em alguns casos será preenchido em atualização posterior.
shoppingCart.userData.emailEmail do usuário criado no BymaParâmetro opcional, em alguns casos será preenchido em atualização posterior.
shoppingCart.userData.phoneTelefone do usuário criado no BymaParâmetro opcional, em alguns casos será preenchido em atualização posterior.
shoppingCart.userData.cpfCPF do usuário criado no BymaParâmetro opcional, em alguns casos será preenchido em atualização posterior.

Exemplo

{
    "eventName": "shoppingcart.created",
    "shoppingCart": {
        "_id": "123",
        "status": "pending",
        "createdAt": "2023-05-11T18:03:26.673Z",
        "expiresAt": "2023-05-11T18:10:26.673Z",
        "ticketCount": 1,
        "eventId": "xyz98765",
        "contents": [
            {
                "ticketTypeId": "345555",
                "quantity": 1
            }
        ],
        "utmParams": {
            "utm_source": "test",
            "utm_medium": "test",
            "utm_campaign": "test",
            "utm_term": "test",
            "utm_content": "test"
        },
        "userData": {
            "name": "João Maria",
            "email": "joao@exemplo.com",
            "cpf": "123456789-00",
            "phone": "123456789"
        }
    }
}

Carrinho atualizado

Descrição

Disparado na atualização de um carrinho no sistema.

Atributos

AtributoValorObservação
eventNameChave (nome) do eventoSerá sempre shoppingcart.updated
shoppingcart._idID do carrinho
shoppingcart.statusStatus do carrinhopending, paid ou expired
shoppingcart.createdAtHorario de criação em formato ISO 8601
shoppingcart.expiresAtHorario de expiração em formato ISO 8601
shoppingcart.ticketCountHorario de expiração em formato ISO 8601
shoppingcart.eventIdID do Evento no Byma
shoppingcart.contentsArray de objetos
shoppingCart.utmParams.utm_sourceParâmetro UTM
shoppingCart.utmParams.utm_mediumParâmetro UTM
shoppingCart.utmParams.utm_campaignParâmetro UTM
shoppingCart.utmParams.utm_termParâmetro UTM
shoppingCart.utmParams.utm_contentParâmetro UTM
shoppingCart.userData.nameNome do usuário criado no BymaParâmetro opcional, em alguns casos será preenchido em atualização posterior.
shoppingCart.userData.emailEmail do usuário criado no BymaParâmetro opcional, em alguns casos será preenchido em atualização posterior.
shoppingCart.userData.phoneTelefone do usuário criado no BymaParâmetro opcional, em alguns casos será preenchido em atualização posterior.
shoppingCart.userData.cpfCPF do usuário criado no BymaParâmetro opcional, em alguns casos será preenchido em atualização posterior.

Exemplo

{
    "eventName": "shoppingcart.updated",
    "shoppingCart": {
        "_id": "123",
        "status": "pending",
        "createdAt": "2023-05-11T18:03:26.673Z",
        "expiresAt": "2023-05-11T18:10:26.673Z",
        "ticketCount": 1,
        "eventId": "xyz98765",
        "contents": [
            {
                "ticketTypeId": "345555",
                "quantity": 1
            }
        ],
        "utmParams": {
            "utm_source": "test",
            "utm_medium": "test",
            "utm_campaign": "test",
            "utm_term": "test",
            "utm_content": "test"
        },
        "userData": {
            "name": "João Maria",
            "email": "joao@exemplo.com",
            "cpf": "123456789-00",
            "phone": "123456789"
        }
    }
}
WebhooksValidando