Sign in

v1

latestOpenAPI 3.0.32026-07-2647114182.1 KB
webhook

API for managing webhook Apps, it inherits from AppPlatformAPI, customizes the schema generation and filters by webhook platform.

post/public_api/webhook/

Request body

idinteger required
status'active' | 'disabled' | 'waiting_config'
  • active - Ativo
  • disabled - Desativado
  • waiting_config - Aguardando Configuração
namestring required

Nome do app

urlstring uri nullable required

URL de destino, onde os eventos serão enviados

productsstring[] required

Produtos que utilizam este app

eventsEventType[] required

custom_id de eventos para associar ao app webhook

Response

Corpo da resposta status 200

idinteger required
status'active' | 'disabled' | 'waiting_config'
  • active - Ativo
  • disabled - Desativado
  • waiting_config - Aguardando Configuração
namestring required

Nome do app

urlstring uri nullable

URL de destino, onde os eventos serão enviados

{"stackTrail":"components:schemas:AppSerializerRead:properties:fields","oasType":"schema","type":"unknown","title":"Campos adicionais","description":"Campos adicionais para o app"}
createdAtstring date-time required

Data e hora de criação

updatedAtstring date-time required

Data e hora da última atualização