Skip to main content
POST
Register webhook destination
Draft: specification in progress. Endpoints and fields may change.

Authorizations

Authorization
string
header
required

The organization's API key (tesa_live_... in production, tesa_test_... in the sandbox).

Headers

Idempotency-Key
string<uuid>

Unique value generated by the integration. Repeating the key with the same body returns the original response.

Body

application/json
url
string<uri>
required
eventos
enum<string>[]
Available options:
deposito.confirmado,
alocacao.proposta,
alocacao.aprovada,
resgate.concluido,
rendimento.apurado,
cobranca.emitida

Response

Destination registered.

id
string
Example:

"wh_6r3n"

url
string<uri>
eventos
enum<string>[]

An empty list subscribes to all events.

Available options:
deposito.confirmado,
alocacao.proposta,
alocacao.aprovada,
resgate.concluido,
rendimento.apurado,
cobranca.emitida
status
enum<string>
Available options:
ativo,
pausado
criado_em
string<date-time>
segredo
string

The destination's HMAC secret. Shown only at creation.

Example:

"whsec_..."