Linkana Webhook Event Types

This is the list of event types that we currently send.
For guidance on how to listen to these events, take a look at Svix's guide to consuming webhooks.

Event Types

document

qualification

supplier

added_by_email

string

null

Optional

E-mail de quem cadastrou o fornecedor

address

object

null

Optional

Endereco resolvido do fornecedor (Suppliers::ResolvedAddress).

bairro

string

null

Optional

blocked_at

string

null

Optional

Data/hora no formato Ruby Time#to_s: 'YYYY-MM-DD HH:MM:SS +ZZZZ' (ex.: '2026-08-13 15:30:08 -0300'). Nao e RFC3339.

blocked_by

string

null

Optional

Nome de quem bloqueou o fornecedor

blocked_reason

string

null

Optional

buyer_documents

object

Campos de cadastro definidos pelo buyer (setting_buyer_documents), chaveados pelo nome do campo. Valores variam por tipo de campo.

0 Items

capital_social

number

null

Optional

Capital social em reais

category

string

Nome de exibicao da categoria

cep

string

null

Optional

cnae_fiscal

string

null

Optional

CNAE fiscal principal

cnae_fiscal_descricao

string

null

Optional

Descrição do CNAE fiscal principal

cnaes_secundarios

array[]

Optional

CNAEs secundários do fornecedor

codigo_natureza_juridica

integer

null

Optional

complemento

string

null

Optional

contact_email

string

null

Optional

country

string

null

Optional

Nome do pais (common_name ISO3166)

data_inicio_atividade

string

null

(date)

Optional

Data ISO 'YYYY-MM-DD'.

decision_at

string

null

Optional

Data/hora no formato Ruby Time#to_s: 'YYYY-MM-DD HH:MM:SS +ZZZZ' (ex.: '2026-08-13 15:30:08 -0300'). Nao e RFC3339.

decision_justification

string

null

Optional

Pode vir como string vazia.

decision_reason

string

null

Optional

Pode vir como string vazia.

desc_tipo_logradouro

string

null

Optional

documents

object

Documentos do fornecedor chaveados pelo webhook_reference configurado.

0 Items

forma_tributacao

string

null

Optional

Codigo da forma de tributacao (ex.: lucro_presumido, simples_nacional)

id

string

UUID do fornecedor

identifier

string

CNPJ, CPF ou TIN

legal_entity

string

PF, PJ ou internacional

logradouro

string

null

Optional

mei

boolean

null

Optional

Optante pelo MEI

mf

string

null

Optional

Indicador matriz/filial (1 = matriz)

municipio

string

null

Optional

name

string

Razao social / nome

natureza_juridica

string

null

Optional

nome_fantasia

string

null

Optional

numero

string

null

Optional

porte

string

null

Optional

Porte da empresa (rotulo)

qualification_buyer_documents

object

Optional

Campos de cadastro vinculados a esta homologacao (presente apenas quando ha campos por homologacao).

0 Items

qualification_created_at

string

(date-time)

qualification_id

string

UUID da homologacao

qualification_initiated_by

string

null

Optional

E-mail de quem iniciou a homologacao

rating

integer

null

Optional

Score da categoria (0-100)

razao_social

string

null

Optional

simples

string

null

Optional

Optante pelo Simples: Sim, Nao ou Excluido

state

string

Estado da homologacao (qualification.state)

supplier_contacts

array[]

Optional

Contatos cadastrados do fornecedor.

tags

array[]

Optional

Marcadores (setting_tags) do fornecedor.

uf

string

null

Optional

added_by_email

string

null

Optional

E-mail de quem cadastrou o fornecedor

address

object

null

Optional

Endereco resolvido do fornecedor (Suppliers::ResolvedAddress).

bairro

string

null

Optional

blocked_at

string

null

Optional

Data/hora no formato Ruby Time#to_s: 'YYYY-MM-DD HH:MM:SS +ZZZZ' (ex.: '2026-08-13 15:30:08 -0300'). Nao e RFC3339.

blocked_by

string

null

Optional

Nome de quem bloqueou o fornecedor

blocked_reason

string

null

Optional

buyer_documents

object

Campos de cadastro definidos pelo buyer (setting_buyer_documents), chaveados pelo nome do campo. Valores variam por tipo de campo.

0 Items

capital_social

number

null

Optional

Capital social em reais

category

string

Nome de exibicao da categoria

cep

string

null

Optional

cnae_fiscal

string

null

Optional

CNAE fiscal principal

cnae_fiscal_descricao

string

null

Optional

Descrição do CNAE fiscal principal

cnaes_secundarios

array[]

Optional

CNAEs secundários do fornecedor

codigo_natureza_juridica

integer

null

Optional

complemento

string

null

Optional

contact_email

string

null

Optional

country

string

null

Optional

Nome do pais (common_name ISO3166)

data_inicio_atividade

string

null

(date)

Optional

Data ISO 'YYYY-MM-DD'.

decision_at

string

null

Optional

Data/hora no formato Ruby Time#to_s: 'YYYY-MM-DD HH:MM:SS +ZZZZ' (ex.: '2026-08-13 15:30:08 -0300'). Nao e RFC3339.

decision_justification

string

null

Optional

Pode vir como string vazia.

decision_reason

string

null

Optional

Pode vir como string vazia.

desc_tipo_logradouro

string

null

Optional

documents

object

Documentos do fornecedor chaveados pelo webhook_reference configurado.

0 Items

forma_tributacao

string

null

Optional

Codigo da forma de tributacao (ex.: lucro_presumido, simples_nacional)

id

string

UUID do fornecedor

identifier

string

CNPJ, CPF ou TIN

legal_entity

string

PF, PJ ou internacional

logradouro

string

null

Optional

mei

boolean

null

Optional

Optante pelo MEI

mf

string

null

Optional

Indicador matriz/filial (1 = matriz)

municipio

string

null

Optional

name

string

Razao social / nome

natureza_juridica

string

null

Optional

nome_fantasia

string

null

Optional

numero

string

null

Optional

porte

string

null

Optional

Porte da empresa (rotulo)

qualification_buyer_documents

object

Optional

Campos de cadastro vinculados a esta homologacao (presente apenas quando ha campos por homologacao).

0 Items

qualification_created_at

string

(date-time)

qualification_id

string

UUID da homologacao

qualification_initiated_by

string

null

Optional

E-mail de quem iniciou a homologacao

rating

integer

null

Optional

Score da categoria (0-100)

razao_social

string

null

Optional

simples

string

null

Optional

Optante pelo Simples: Sim, Nao ou Excluido

state

string

Estado da homologacao (qualification.state)

supplier_contacts

array[]

Optional

Contatos cadastrados do fornecedor.

tags

array[]

Optional

Marcadores (setting_tags) do fornecedor.

uf

string

null

Optional

added_by_email

string

null

Optional

E-mail de quem cadastrou o fornecedor

address

object

null

Optional

Endereco resolvido do fornecedor (Suppliers::ResolvedAddress).

bairro

string

null

Optional

blocked_at

string

null

Optional

Data/hora no formato Ruby Time#to_s: 'YYYY-MM-DD HH:MM:SS +ZZZZ' (ex.: '2026-08-13 15:30:08 -0300'). Nao e RFC3339.

blocked_by

string

null

Optional

Nome de quem bloqueou o fornecedor

blocked_reason

string

null

Optional

buyer_documents

object

Campos de cadastro definidos pelo buyer (setting_buyer_documents), chaveados pelo nome do campo. Valores variam por tipo de campo.

0 Items

capital_social

number

null

Optional

Capital social em reais

category

string

Nome de exibicao da categoria

cep

string

null

Optional

cnae_fiscal

string

null

Optional

CNAE fiscal principal

cnae_fiscal_descricao

string

null

Optional

Descrição do CNAE fiscal principal

cnaes_secundarios

array[]

Optional

CNAEs secundários do fornecedor

codigo_natureza_juridica

integer

null

Optional

complemento

string

null

Optional

contact_email

string

null

Optional

country

string

null

Optional

Nome do pais (common_name ISO3166)

data_inicio_atividade

string

null

(date)

Optional

Data ISO 'YYYY-MM-DD'.

decision_at

string

null

Optional

Data/hora no formato Ruby Time#to_s: 'YYYY-MM-DD HH:MM:SS +ZZZZ' (ex.: '2026-08-13 15:30:08 -0300'). Nao e RFC3339.

decision_justification

string

null

Optional

Pode vir como string vazia.

decision_reason

string

null

Optional

Pode vir como string vazia.

desc_tipo_logradouro

string

null

Optional

documents

object

Documentos do fornecedor chaveados pelo webhook_reference configurado.

0 Items

forma_tributacao

string

null

Optional

Codigo da forma de tributacao (ex.: lucro_presumido, simples_nacional)

id

string

UUID do fornecedor

identifier

string

CNPJ, CPF ou TIN

legal_entity

string

PF, PJ ou internacional

logradouro

string

null

Optional

mei

boolean

null

Optional

Optante pelo MEI

mf

string

null

Optional

Indicador matriz/filial (1 = matriz)

municipio

string

null

Optional

name

string

Razao social / nome

natureza_juridica

string

null

Optional

nome_fantasia

string

null

Optional

numero

string

null

Optional

porte

string

null

Optional

Porte da empresa (rotulo)

qualification_buyer_documents

object

Optional

Campos de cadastro vinculados a esta homologacao (presente apenas quando ha campos por homologacao).

0 Items

qualification_created_at

string

(date-time)

qualification_id

string

UUID da homologacao

qualification_initiated_by

string

null

Optional

E-mail de quem iniciou a homologacao

rating

integer

null

Optional

Score da categoria (0-100)

razao_social

string

null

Optional

simples

string

null

Optional

Optante pelo Simples: Sim, Nao ou Excluido

state

string

Estado da homologacao (qualification.state)

supplier_contacts

array[]

Optional

Contatos cadastrados do fornecedor.

tags

array[]

Optional

Marcadores (setting_tags) do fornecedor.

uf

string

null

Optional

added_by_email

string

null

Optional

E-mail de quem cadastrou o fornecedor

address

object

null

Optional

Endereco resolvido do fornecedor (Suppliers::ResolvedAddress).

bairro

string

null

Optional

blocked_at

string

null

Optional

Data/hora no formato Ruby Time#to_s: 'YYYY-MM-DD HH:MM:SS +ZZZZ' (ex.: '2026-08-13 15:30:08 -0300'). Nao e RFC3339.

blocked_by

string

null

Optional

Nome de quem bloqueou o fornecedor

blocked_reason

string

null

Optional

buyer_documents

object

Campos de cadastro definidos pelo buyer (setting_buyer_documents), chaveados pelo nome do campo. Valores variam por tipo de campo.

0 Items

capital_social

number

null

Optional

Capital social em reais

category

string

Nome de exibicao da categoria

cep

string

null

Optional

cnae_fiscal

string

null

Optional

CNAE fiscal principal

cnae_fiscal_descricao

string

null

Optional

Descrição do CNAE fiscal principal

cnaes_secundarios

array[]

Optional

CNAEs secundários do fornecedor

codigo_natureza_juridica

integer

null

Optional

complemento

string

null

Optional

contact_email

string

null

Optional

country

string

null

Optional

Nome do pais (common_name ISO3166)

data_inicio_atividade

string

null

(date)

Optional

Data ISO 'YYYY-MM-DD'.

decision_at

string

null

Optional

Data/hora no formato Ruby Time#to_s: 'YYYY-MM-DD HH:MM:SS +ZZZZ' (ex.: '2026-08-13 15:30:08 -0300'). Nao e RFC3339.

decision_justification

string

null

Optional

Pode vir como string vazia.

decision_reason

string

null

Optional

Pode vir como string vazia.

desc_tipo_logradouro

string

null

Optional

documents

object

Documentos do fornecedor chaveados pelo webhook_reference configurado.

0 Items

forma_tributacao

string

null

Optional

Codigo da forma de tributacao (ex.: lucro_presumido, simples_nacional)

id

string

UUID do fornecedor

identifier

string

CNPJ, CPF ou TIN

legal_entity

string

PF, PJ ou internacional

logradouro

string

null

Optional

mei

boolean

null

Optional

Optante pelo MEI

mf

string

null

Optional

Indicador matriz/filial (1 = matriz)

municipio

string

null

Optional

name

string

Razao social / nome

natureza_juridica

string

null

Optional

nome_fantasia

string

null

Optional

numero

string

null

Optional

porte

string

null

Optional

Porte da empresa (rotulo)

rating

integer

null

Optional

Score da categoria (0-100)

razao_social

string

null

Optional

simples

string

null

Optional

Optante pelo Simples: Sim, Nao ou Excluido

state

string

Estado da homologacao (qualification.state)

supplier_contacts

array[]

Optional

Contatos cadastrados do fornecedor.

tags

array[]

Optional

Marcadores (setting_tags) do fornecedor.

uf

string

null

Optional

added_by_email

string

null

Optional

E-mail de quem cadastrou o fornecedor

address

object

null

Optional

Endereco resolvido do fornecedor (Suppliers::ResolvedAddress).

bairro

string

null

Optional

blocked_at

string

null

Optional

Data/hora no formato Ruby Time#to_s: 'YYYY-MM-DD HH:MM:SS +ZZZZ' (ex.: '2026-08-13 15:30:08 -0300'). Nao e RFC3339.

blocked_by

string

null

Optional

Nome de quem bloqueou o fornecedor

blocked_reason

string

null

Optional

buyer_documents

object

Campos de cadastro definidos pelo buyer (setting_buyer_documents), chaveados pelo nome do campo. Valores variam por tipo de campo.

0 Items

capital_social

number

null

Optional

Capital social em reais

category

string

Nome de exibicao da categoria

cep

string

null

Optional

cnae_fiscal

string

null

Optional

CNAE fiscal principal

cnae_fiscal_descricao

string

null

Optional

Descrição do CNAE fiscal principal

cnaes_secundarios

array[]

Optional

CNAEs secundários do fornecedor

codigo_natureza_juridica

integer

null

Optional

complemento

string

null

Optional

contact_email

string

null

Optional

country

string

null

Optional

Nome do pais (common_name ISO3166)

data_inicio_atividade

string

null

(date)

Optional

Data ISO 'YYYY-MM-DD'.

decision_at

string

null

Optional

Data/hora no formato Ruby Time#to_s: 'YYYY-MM-DD HH:MM:SS +ZZZZ' (ex.: '2026-08-13 15:30:08 -0300'). Nao e RFC3339.

decision_justification

string

null

Optional

Pode vir como string vazia.

decision_reason

string

null

Optional

Pode vir como string vazia.

desc_tipo_logradouro

string

null

Optional

documents

object

Documentos do fornecedor chaveados pelo webhook_reference configurado.

0 Items

forma_tributacao

string

null

Optional

Codigo da forma de tributacao (ex.: lucro_presumido, simples_nacional)

id

string

UUID do fornecedor

identifier

string

CNPJ, CPF ou TIN

legal_entity

string

PF, PJ ou internacional

logradouro

string

null

Optional

mei

boolean

null

Optional

Optante pelo MEI

mf

string

null

Optional

Indicador matriz/filial (1 = matriz)

municipio

string

null

Optional

name

string

Razao social / nome

natureza_juridica

string

null

Optional

nome_fantasia

string

null

Optional

numero

string

null

Optional

porte

string

null

Optional

Porte da empresa (rotulo)

rating

integer

null

Optional

Score da categoria (0-100)

razao_social

string

null

Optional

simples

string

null

Optional

Optante pelo Simples: Sim, Nao ou Excluido

state

string

Estado da homologacao (qualification.state)

supplier_contacts

array[]

Optional

Contatos cadastrados do fornecedor.

tags

array[]

Optional

Marcadores (setting_tags) do fornecedor.

uf

string

null

Optional

added_by_email

string

null

Optional

E-mail de quem cadastrou o fornecedor

address

object

null

Optional

Endereco resolvido do fornecedor (Suppliers::ResolvedAddress).

bairro

string

null

Optional

blocked_at

string

null

Optional

Data/hora no formato Ruby Time#to_s: 'YYYY-MM-DD HH:MM:SS +ZZZZ' (ex.: '2026-08-13 15:30:08 -0300'). Nao e RFC3339.

blocked_by

string

null

Optional

Nome de quem bloqueou o fornecedor

blocked_reason

string

null

Optional

buyer_documents

object

Campos de cadastro definidos pelo buyer (setting_buyer_documents), chaveados pelo nome do campo. Valores variam por tipo de campo.

0 Items

capital_social

number

null

Optional

Capital social em reais

category

string

Nome de exibicao da categoria

cep

string

null

Optional

cnae_fiscal

string

null

Optional

CNAE fiscal principal

cnae_fiscal_descricao

string

null

Optional

Descrição do CNAE fiscal principal

cnaes_secundarios

array[]

Optional

CNAEs secundários do fornecedor

codigo_natureza_juridica

integer

null

Optional

complemento

string

null

Optional

contact_email

string

null

Optional

country

string

null

Optional

Nome do pais (common_name ISO3166)

data_inicio_atividade

string

null

(date)

Optional

Data ISO 'YYYY-MM-DD'.

decision_at

string

null

Optional

Data/hora no formato Ruby Time#to_s: 'YYYY-MM-DD HH:MM:SS +ZZZZ' (ex.: '2026-08-13 15:30:08 -0300'). Nao e RFC3339.

decision_justification

string

null

Optional

Pode vir como string vazia.

decision_reason

string

null

Optional

Pode vir como string vazia.

desc_tipo_logradouro

string

null

Optional

documents

object

Documentos do fornecedor chaveados pelo webhook_reference configurado.

0 Items

forma_tributacao

string

null

Optional

Codigo da forma de tributacao (ex.: lucro_presumido, simples_nacional)

id

string

UUID do fornecedor

identifier

string

CNPJ, CPF ou TIN

legal_entity

string

PF, PJ ou internacional

logradouro

string

null

Optional

mei

boolean

null

Optional

Optante pelo MEI

mf

string

null

Optional

Indicador matriz/filial (1 = matriz)

municipio

string

null

Optional

name

string

Razao social / nome

natureza_juridica

string

null

Optional

nome_fantasia

string

null

Optional

numero

string

null

Optional

porte

string

null

Optional

Porte da empresa (rotulo)

rating

integer

null

Optional

Score da categoria (0-100)

razao_social

string

null

Optional

simples

string

null

Optional

Optante pelo Simples: Sim, Nao ou Excluido

state

string

Estado da homologacao (qualification.state)

supplier_contacts

array[]

Optional

Contatos cadastrados do fornecedor.

tags

array[]

Optional

Marcadores (setting_tags) do fornecedor.

uf

string

null

Optional

Linkana Webhook Event Types

Event Types

document.reviewed

buyer_documents

documents

identifier

supplier_id

qualification_temp.approved

added_by_email

address

bairro

blocked_at

blocked_by

blocked_reason

buyer_documents

capital_social

category

cep

cnae_fiscal

cnae_fiscal_descricao

cnaes_secundarios

codigo_natureza_juridica

complemento

contact_email

country

data_inicio_atividade

decision_at

decision_justification

decision_reason

desc_tipo_logradouro

documents

forma_tributacao

id

identifier

legal_entity

logradouro

mei

mf

municipio

name

natureza_juridica

nome_fantasia

numero

porte

qualification_buyer_documents

qualification_created_at

qualification_id

qualification_initiated_by

rating

razao_social

simples

state

supplier_contacts

tags

uf

qualification_temp.created

added_by_email

address

bairro

blocked_at

blocked_by

blocked_reason

buyer_documents

capital_social

category

cep

cnae_fiscal

cnae_fiscal_descricao

cnaes_secundarios

codigo_natureza_juridica

complemento

contact_email

country

data_inicio_atividade

decision_at

decision_justification

decision_reason

desc_tipo_logradouro

documents

forma_tributacao