Skip to main content
Skip table of contents

Webhook para E-tickets

É possível utilizar webhook, para que seu sistema seja notificado sobre as alterações que ocorram nos ingressos.

Campo

Tipo

Obrigatório

Descrição

api_token

Char(40)

Sim

Chave de API do Guru

attendee.address_country

String(191)

Não

País

attendee.email

String(191)

Não

E-mail

attendee.name

String(191)

Não

Nome

attendee.phone_local_code

String(191)

Não

Indicativo do telefone

attendee.phone_number

String(191)

Não

Telefone

code

String(30)

Sim

Código do Eticket

dates.created_at

YYYY-MM-DDTHH:MM:SSZ

Sim

Data da Criação

dates.updated_at

YYYY-MM-DDTHH:MM:SSZ

Sim

Data de Atualização

dates.checked_in_at

YYYY-MM-DDTHH:MM:SSZ

Não

Data do Check In

hash

String(191)

Sim

Hash do Eticket

hash_url

String

Sim

Url do Eticket

id

String(191)

Sim

ID do Eticket

owner.email

String(191)

Não

E-mail do Contacto

owner.id

String(191)

Não

Id do Contacto

owner.name

String(191)

Não

Nome do Contacto

owner.phone_local_code

String(191)

Não

Indicativo do telefone do Contacto

owner.phone_number

String(191)

Não

Telefone do Contacto

product.id

String(191)

Sim

Id interno do produto

product.image_url

String

Não

Imagem do produto

product.marketplace_id

String

Sim

Id do marketplace

product.marketplace_name

String(191)

Sim

Nome do marketplace do produto

product.name

String(191)

Sim

Nome do produto

product.offer.id

String(191)

Sim

Id da oferta

product.offer.name

String(191)

Sim

Nome da oferta

product.event_details.address_city

String

Não

Cidade

product.event_details.address_comp

String

Não

Complemento

product.event_details.address_country

String

Não

País

product.event_details.address_district

String

Não

Bairro

product.event_details.address_local

String

Não

Local

product.event_details.address_number

String

Não

Número

product.event_details.address_state_full_name

String

Não

Estado (nome completo)

product.event_details.address_state

String

Não

Estado

product.event_details.address_zip_code

String

Não

Código Postal

product.event_details.address

String

Não

Endereço

product.event_details.allow_duplicate_emails

Boolean (0/1)

Não

Permite emails duplicados

product.event_details.automatic_ticket_assignment

Boolean (0/1)

Não

Atribui atomaticamente ingresso ao comprador

product.event_details.end_at

YYYY-MM-DDTHH:MM:SSZ

Não

Data final do evento

product.event_details.start_at

YYYY-MM-DDTHH:MM:SSZ

Não

Data inicial do evento

product.event_details.timezone_abbr

String

Sim

Timezone (abreviado)

product.event_details.timezone

String

Sim

Timezone

product.event_details.type

String (in_person | online)

Sim

Tipo do evento (presencial / online)

product.event_details.url

String

Não

Url do evento

product.producer.marketplace_id

String(191)

Sim

Id Marketplace do produtor

product.producer.name

String(191)

Sim

Nome do produtor

product.producer.contact_email

String(191)

Não

Email do produtor

status

EticketStatus

Sim

Status do Eticket

transaction.affiliations.*.marketplace_id

String(191)

Não

Id do marketplace da afiliação

transaction.affiliations.*.name

String(191)

Não

Nome da afiliação

transaction.affiliations.*.contact_email

String(191)

Não

Email da afiliação

transaction.affiliations.*.value

Float

Não

Valor da comissão da afiliação

transaction.affiliations.*.currency

String(191)

Não

Moeda da afiliação

transaction.checkout_url

String

Não

Url do Checkout do Guru

transaction.contact.id

Integer

Não

Id

transaction.contact.name

String(191)

Não

Nome

transaction.contact.email

String(191)

Não

E-mail

transaction.contact.doc

String(191)

Não

Documento

transaction.contact.phone_number

String(191)

Não

Telefone

transaction.contact.phone_local_code

String(191)

Não

Indicativo do telefone

transaction.contact.address

String(191)

Não

Endereço

transaction.contact.address_number

String(191)

Não

Número

transaction.contact.address_comp

String(191)

Não

Complemento

transaction.contact.address_district

String(191)

Não

Bairro

transaction.contact.address_city

String(191)

Não

Cidade

transaction.contact.address_state

String(191)

Não

Estado

transaction.contact.address_state_full_name

String

Não

Nome completo do estado

transaction.contact.address_country

String(191)

Não

País

transaction.contact.address_zip_code

String(191)

Não

Código Postal

transaction.contact.lead.first_tracking.name

String(191)

Não

Nome do primeiro rastreio do lead

transaction.contact.lead.first_tracking.type

TrackingType

Não

Tipo do primeiro rastreio do lead

transaction.contact.lead.first_tracking.publisher

Publisher

Não

Anunciante do primeiro rastreio do lead

transaction.contact.lead.first_tracking.tracked_at

YYYY-MM-DDTHH:MM:SSZ

Não

Data do primeiro rastreio do lead

transaction.contact.lead.last_tracking.name

String(191)

Não

Nome do último rastreio do lead

transaction.contact.lead.last_tracking.type

TrackingType

Não

Tipo do último rastreio do lead

transaction.contact.lead.last_tracking.publisher

Publisher

Não

Anunciante do último rastreio do lead

transaction.contact.lead.last_tracking.tracked_at

YYYY-MM-DDTHH:MM:SSZ

Não

Data do último rastreio do lead

transaction.dates.canceled_at

YYYY-MM-DDTHH:MM:SSZ

Não

Data do Cancelamento

transaction.dates.confirmed_at

YYYY-MM-DDTHH:MM:SSZ

Não

Data da Aprovação

transaction.dates.created_at

YYYY-MM-DDTHH:MM:SSZ

Não

Data de Criação

transaction.dates.expires_at

YYYY-MM-DDTHH:MM:SSZ

Não

Data de Expiração

transaction.dates.ordered_at

YYYY-MM-DDTHH:MM:SSZ

Sim

Data do Pedido

transaction.dates.unavailable_until

YYYY-MM-DDTHH:MM:SSZ

Não

Indisponível até

transaction.dates.updated_at

YYYY-MM-DDTHH:MM:SSZ

Não

Data de atualização

transaction.dates.warranty_until

YYYY-MM-DDTHH:MM:SSZ

Não

Garantia até

transaction.ecommerces.magento.order_id

Integer

Não

Número do Pedido Magento

transaction.ecommerces.kapsula.pedido

Integer

Não

Número do Pedido Kapsula

transaction.ecommerces.magento.quote_id

Integer

Não

Número da Cotação Magento

transaction.ecommerces.shopify.order_id

Integer

Não

Número do Pedido Shopify

transaction.ecommerces.shopify.transaction_id

Integer

Não

Número da Transação Shopify

transaction.ecommerces.woocommerce.id

Integer

Não

Número do Pedido Woocommerce

transaction.extras.accepted_terms_url

Integer

Sim

Indica que o comprador aceitou os termos de utilização

transaction.extras.accepted_privacy_policy_url

Integer

Sim

Indica que o comprador aceitou a política de privacidade

transaction.id

String(191)

Sim

ID da Transação

transaction.infrastructure.ip

String(191)

Não

IP do comprador

transaction.infrastructure.city

String(191)

Não

Cidade do comprador

transaction.infrastructure.region

String

Não

Região do comprador

transaction.infrastructure.host

String

Não

Host do comprador

transaction.infrastructure.country

String(191)

Não

País do comprador

transaction.infrastructure.user_agent

String(191)

Não

User Agent do comprador

transaction.infrastructure.city_lat_long

String(191)

Não

Coordenadas do comprador

transaction.invoice.charge_at

YYYY-MM-DD

Sim

Data de cobrança

transaction.invoice.created_at

YYYY-MM-DDTHH:MM:SSZ

Sim

Data de criação da fatura

transaction.invoice.cycle

Integer

Sim

Ciclo da assinatura a que se refere a fatura

transaction.invoice.discount_value

Float

Sim

Valor do desconto

transaction.invoice.id

String

Sim

ID da fatura

transaction.invoice.increment_value

Float

Sim

Valor do incremento

transaction.invoice.period_end

YYYY-MM-DD

Sim

Data do final do período

transaction.invoice.period_start

YYYY-MM-DD

Sim

Data do início do período

transaction.invoice.status

String

Sim

Status da fatura

transaction.invoice.tax_value

Float

Sim

Valor do imposto

transaction.invoice.tries

Integer

Sim

Número total de tentativas

transaction.invoice.try

Integer

Sim

Número da tentativa

transaction.invoice.type

Status

Sim

Tipo da fatura

transaction.invoice.value

Float

Sim

Valor da fatura

transaction.payment.affiliate_value

Float

Sim

Valor Afiliados

transaction.payment.acquirer.code

String

Sim

Código do adquirente

transaction.payment.acquirer.message

String

Sim

Mensagem do adquirente

transaction.payment.acquirer.name

String

Sim

Nome do adquirente

transaction.payment.acquirer.nsu

String

Sim

NSU do adquirente

transaction.payment.acquirer.tid

String

Sim

TID do adquirente

transaction.payment.can_try_again

Integer (0/1)

Sim

Indica se pode tentar novamente

transaction.payment.coupon.id

String

Não

Id do cupom

transaction.payment.coupon.coupon_code

String

Não

Código do cupom

transaction.payment.coupon.incidence_type

String

Não

Tipo de incidência do cupom

transaction.payment.coupon.incidence_field

String

Não

Incidência do cupom

transaction.payment.coupon.incidence_value

Float

Não

Valor do cupom

transaction.payment.coupon.last_sent_at

Integer

Não

Unix timestamp

transaction.payment.coupon.final_value

Float

Não

Valor final do cupom

transaction.payment.currency

String(191)

Sim

Moeda (ISO 4217)

transaction.payment.discount_value

Float

Sim

Valor Desconto

transaction.payment.gross

Float

Sim

Valor Bruto

transaction.payment.instalments.value

Float

Não

Valor das Parcelas

transaction.payment.instalments.qty

Integer

Não

Quantidade de Parcelas da venda

transaction.payment.installments.interest

Float

Não

Valor dos juros do parcelamento

transaction.payment.marketplace_id

String(191)

Sim

Código da Venda no Processador de Pagamento

transaction.payment.marketplace_name

String(191)

Sim

Processador de Pagamento

transaction.payment.marketplace_value

Float

Sim

Valor do Processador de Pagamento

transaction.payment.method

PaymentMethod

Sim

Método de Pagamento

transaction.payment.net

Float

Sim

Valor Líquido

transaction.payment.processing_times.started_at

YYYY-MM-DDTHH:MM:SSZ

Não

Data de início do processamento

transaction.payment.processing_times.finished_at

YYYY-MM-DDTHH:MM:SSZ

Não

Data de final do processamento

transaction.payment.processing_times.delay_in_seconds

Integer

Não

Atraso (em segundos)

transaction.payment.refund_reason

String

Não

Razão de reembolso

transaction.payment.refuse_reason

String(191)

Não

Mensagem do processador de pagamento

transaction.payment.tax.value

Float

Não

Valor da Taxa

transaction.payment.tax.rate

Float

Não

Porcentagem da Taxa

transaction.payment.total

Float

Sim

Valor Total

transaction.payment.creditcard.brand

String(191)

Não

Bandeira do cartão

transaction.payment.creditcard.expiration_month

String

Não

Mês de expiração do cartão

transaction.payment.creditcard.expiration_year

String

Não

Ano de expiração do cartão

transaction.payment.creditcard.first_digits

Integer

Não

Bin do cartão

transaction.payment.creditcard.id

String

Não

Id do cartão

transaction.payment.creditcard.last_digits

Integer

Não

Quatro últimos dígitos do cartão

transaction.payment.billet.line

String(191)

Não

Linha Digitável do Boleto

transaction.payment.billet.url

String(191)

Não

Url do Boleto

transaction.payment.billet.expiration_date

String(191)

Não

Data de Expiração do Boleto

transaction.payment.pix.qrcode.signature

String(191)

Não

Código QRCode do Pix

transaction.payment.pix.qrcode.url

String(191)

Não

URL QRCode do Pix

transaction.payment.pix.expiration_date

String(191)

Não

Data de Expiração do Pix

transaction.payment.spei.url

String(191)

Não

URL do pagamento SPEI

transaction.payment.spei.account

String(191)

Não

Código da Conta SPEI

transaction.payment.spei.reference

String(191)

Não

Código da Referência SPEI

transaction.payment.spei.expiration_date

String(191)

Não

Data de Expiração do SPEI

transaction.payment.oxxo.url

String(191)

Não

URL do pagamento OXXO

transaction.payment.oxxo.barcode

String(191)

Não

Código de Barras OXXO

transaction.payment.oxxo.expiration_date

String(191)

Não

Data de Expiração do OXXO

transaction.product.id

String(191)

Sim

Id do produto

transaction.product.image_url

String(191)

Não

Imagem do produto

transaction.product.internal_id

String

Sim

Id interno do produto

transaction.product.marketplace_id

String

Sim

Id do marketplace

transaction.product.marketplace_name

String(191)

Sim

Nome do marketplace do produto

transaction.product.name

String(191)

Sim

Nome do produto

transaction.product.offer.id

String

Sim

Id da oferta

transaction.product.offer.name

String

Sim

Nome da oferta

transaction.product.producer.marketplace_id

String(191)

Sim

Id Marketplace do produtor

transaction.product.producer.name

String(191)

Sim

Nome do produtor

transaction.product.producer.contact_email

String(191)

Não

Email do produtor

transaction.product.qty

Integer

Sim

Quantidade do produto

transaction.product.total_value

Float

Sim

Valor total do produto

transaction.product.type

String(191)

plan/product

Tipo do produto

transaction.product.unit_value

Float

Sim

Valor unitário do produto

transaction.shipment.carrier

String(191)

Não

Nome da transportadora

transaction.shipment.service

String(191)

Não

Serviço da transportadora

transaction.shipment.tracking

String(191)

Não

Código de rastremanto

transaction.shipment.value

Float

Não

Valor da transportadora

transaction.shipment.status

Array

Não

Estados do envio

transaction.shipment.delivery_time

Integer

Não

Tempo de entrega

transaction.shipping.name

String

Sim

Nome do frete

transaction.shipping.value

Float

Sim

Valor do frete

transaction.source.source

String(191)

Não

Origem da Venda

transaction.source.checkout_source

String(191)

Não

Origem da Venda

transaction.source.utm_source

String(191)

Não

Origem da Venda

transaction.source.utm_campaign

String(191)

Não

Origem da Venda

transaction.source.utm_medium

String(191)

Não

Origem da Venda

transaction.source.utm_content

String(191)

Não

Origem da Venda

transaction.source.utm_term

String(191)

Não

Origem da Venda

transaction.source.pptc.tracking_name

String(191)

Não

Nome do Rastreamento

transaction.source.pptc.tracking_type

TrackingType

Não

Tipo do Rastreamento

transaction.source.pptc.tracking_publisher

Publisher

Não

Anunciante do Rastreamento

transaction.source.pptc.user_name

String(191)

Não

Nome do usuário

transaction.source.pptc.checkout_name

String(191)

Não

Nome do checkout

transaction.source.pptc.utm_campaign

String(191)

Não

UTM_CAMPAIGN do Rastreamento

transaction.source.pptc.utm_medium

String(191)

Não

UTM_MEDIUM do Rastreamento

transaction.source.pptc.utm_content

String(191)

Não

UTM_CONTENT do Rastreamento

transaction.source.pptc.utm_term

String(191)

Não

UTM_TERM do Rastreamento

transaction.status

TransactionStatus

Sim

Status da Venda

transaction.type

Types

Sim

Tipo da venda

Exemplo de JSON a ser recebido [POST]

A notificação consiste em um POST contendo um JSON, conforme exemplo:

CODE 
{
    "api_token": "mLjcGjzKGnXme5b7gbuKMggL34Ecdt5NHGihxfWr",
    "attendee": {
        "address_country": "BR",
        "email": "email@example.com",
        "email_is_deliverable": 1,
        "name": "Nome Participante",
        "phone_local_code": "55",
        "phone_number": "123456789"
    },
    "cancel_reason": "",
    "code": "etkt_4INRdz2zLbppSrHpsaCR",
    "dates": {
        "created_at": "2024-12-26T16:16:07Z",
        "updated_at": "2024-12-26T17:10:07Z",
        "checked_in_at": "2024-12-27T11:34:07Z"
    },
    "hash": "e4ea20ce6c01b35ce5828af84e7c70f44b354a2f03624847585a20c57827ba45",
    "hash_url": "https://clkdmg.site/etickets/e4ea20ce6c01b35ce5828af84e7c70f44b354a2f03624847585a20c57827ba45",
    "id": "9dd37a5f-0b7c-47b5-bd11-49c04bcbe451",
    "owner": {
        "email": "email@sandbox.com",
        "id": "99f7127b-b641-480d-9f15-c6a4f81f627e",
        "name": "Owner Name",
        "phone_local_code": "55",
        "phone_number": "123456789"
    },
    "product": {
        "id": "9c492644-845f-470d-9dac-0a251d291b7c",
        "image_url": "",
        "marketplace_id": "1718379862",
        "marketplace_name": "pagarme",
        "name": "product name",
        "offer": {
            "id": "9c49271c-25c6-4a89-a3d6-3c25e60c2e01",
            "name": "offer name"
        },
        "event_details": {
            "url": "https://eventdomain.com",
            "end_at": "2029-08-04T21:00:00Z",
            "address": "Avenida da Liberdade",
            "start_at": "2029-08-04T21:00:00Z",
            "address_city": "tijuca",
            "address_comp": "complemento",
            "address_local": "Centro de Congressos",
            "address_state": "AM",
            "address_number": "120",
            "address_country": "BR",
            "address_district": "Rio de Janeiro",
            "address_zip_code": "38408254",
            "automatic_ticket_assignment": 1,
            "allow_duplicate_emails": 0,
            "timezone": "America/Bahia",
            "type": "in_person",
            "address_state_full_name": "AM",
            "timezone_abbr": "BRT"
        },
        "producer": {
            "marketplace_id": "26849805000106",
            "name": "Name",
            "contact_email": "ana.contacto@sandbox.com"
        }
    },
    "status": "invited",
    "transaction": {
        "affiliations": [],
        "checkout_url": "https://clkdmg.site/subscribe/9059bdb6-0ca4-4253-b405-482df6393537",
        "contact": {
            "address": "Rua Terra Rica",
            "address_city": "Pinhais",
            "address_comp": "",
            "address_country": "BR",
            "address_district": "Centro",
            "address_number": "123",
            "address_state": "PR",
            "address_state_full_name": "Aveiro",
            "address_zip_code": "83324090",
            "company_name": "",
            "doc": "01234567890",
            "email": "email@email.email",
            "id": "906d1e37-de6a-4f4d-8271-91ecd0d65ec6",
            "lead": {
                "first_tracking": {
                    "name": "TEstes",
                    "publisher": "",
                    "tracked_at": "2020-02-18T15:50:11Z",
                    "type": "form"
                },
                "last_tracking": {
                    "name": "Teste Tracking Plano",
                    "publisher": "Adwords",
                    "tracked_at": "2020-04-02T16:03:08Z",
                    "type": "lead"
                }
            },
            "name": "Nome Contacto",
            "phone_local_code": "55",
            "phone_number": "1234567980"
        },
        "dates": {
            "canceled_at": null,
            "confirmed_at": "2020-05-07T11:35:57Z",
            "created_at": "2024-02-28T14:45:07Z",
            "expires_at": null,
            "ordered_at": "2020-05-07T11:33:45Z",
            "unavailable_until": "2020-06-06T11:35:57Z",
            "updated_at": "2024-02-28T14:50:36Z",
            "warranty_until": "2020-06-06T11:35:57Z"
        },
        "ecommerces": [],
        "extras": {
            "accepted_terms_url": 1,
            "accepted_privacy_policy_url": 1
        },
        "id": "9081534a-7512-4dab-9172-218c1dc1f263",
        "infrastructure": {
            "city": null,
            "city_lat_long": null,
            "country": "BR",
            "host": "https://clkdmg.site",
            "ip": "127.0.0.1",
            "region": null,
            "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36"
        },
        "invoice": {
            "charge_at": "2024-12-13",
            "created_at": "2024-02-28T14:39:42Z",
            "cycle": 2,
            "discount_value": 0,
            "id": "in_y5ZoRccnvFrFEgkPE",
            "increment_value": 0,
            "period_end": "2025-12-13",
            "period_start": "2024-12-13",
            "status": "paid",
            "tax_value": 5.49,
            "tries": 3,
            "try": 3,
            "type": "cycle",
            "value": 29.37
        },
        "payment": {
            "acquirer": {
                "code": "",
                "message": "",
                "name": "",
                "nsu": "",
                "tid": ""
            },
            "affiliate_value": 0,
            "can_try_again": 1,
            "coupon": null,
            "billet": {
                "expiration_date": "",
                "line": "",
                "url": ""
            },
            "credit_card": {
                "brand": "visa",
                "expiration_month": 12,
                "expiration_year": 2024,
                "first_digits": "400000",
                "id": "card_WLmNYk1fmKUOwBwX",
                "last_digits": "0010"
            },
            "currency": "BRL",
            "discount_value": 0,
            "gross": 500,
            "installments": {
                "interest": 0,
                "qty": 1,
                "value": ""
            },
            "marketplace_id": "ch_1ke4QoCQOs7VE6VY",
            "marketplace_name": "mundipagg",
            "marketplace_value": 0,
            "method": null,
            "net": 500,
            "processing_times": {
                "delay_in_seconds": 2,
                "finished_at": "2024-02-28T14:50:02.397Z",
                "started_at": "2024-02-28T14:50:00.241Z"
            },
            "refund_reason": "",
            "refuse_reason": "Transação capturada com sucesso",
            "tax": {
                "rate": 0,
                "value": 0
            },
            "total": 500
        },
        "product": {
            "id": "1587151083",
            "image_url": "",
            "internal_id": "906d1e37-de6a-4f4d-8271-91ecd0d65e32",
            "marketplace_id": "1587151083",
            "marketplace_name": "mundipagg",
            "name": "Assinatura Mundipagg",
            "offer": {
                "id": "9ad505be-e7f9-4a08-a591-3ec4991c2615",
                "name": "bvm - stripe - assinatura1 - oferta1"
            },
            "producer": {
                "contact_email": "",
                "marketplace_id": "01234567890",
                "name": "Produtor Mundipagg"
            },
            "qty": 1,
            "total_value": 500,
            "type": "plan",
            "unit_value": 500
        },
        "shipment": {
            "carrier": "Correios",
            "delivery_time": 15,
            "service": "SEDEX",
            "status": [],
            "tracking": "ME20000BGL2BR",
            "value": 105.68
        },
        "shipping": {
            "name": "Standard",
            "value": 0
        },
        "source": {
            "checkout_source": "",
            "pptc": [],
            "source": "",
            "utm_campaign": "",
            "utm_content": "",
            "utm_medium": "",
            "utm_source": "",
            "utm_term": ""
        },
        "status": "approved",
        "type": "producer"
    }
}

Mais Recursos

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close