POST
/
v1
/
webhooks

Authorizations

X-Client-Id
string
headerrequired
X-Api-Key
string
headerrequired

Body

application/json
event
string
required

Evento que deseja receber notificações no seu webhook conforme descrito na seção Eventos suportados para notificação via webhooks. Deve ser criado um webhook para cada evento, podendo ser utilizado o wildcard * no lugar do evento para receber todos os eventos em um único webhook.

endpoint
string
required

URL do seu sistema que deverá receber as notificações de evento, o valor não pode se repetir em outro webhook.

version
number
default: 1.1required

Versão da api da Malga que seu webhook implementa

status
boolean
default: truerequired

Identifica se o webhooks está ativo ou não para receber notificações de evento da Malga

Response

201 - application/json
id
string

identificador do webhook

createdAt
string

data de criação

clientId
string

identificador do client

event
string

Tipo do evento que deseja receber notificações no seu webhook

endpoint
string

URL do seu sistema que deverá receber as notificações de evento

version
number
default: 1.1

Versão da api da Malga que seu webhook implementa

publicKey
string

Chave pública ed25519

status
boolean
default: true

Identifica se o webhooks está ativo ou não para receber notificações de evento da Malga

Was this page helpful?

Listagem de webhooks cadastradosRecuperar detalhes de webhook