webhook

PUT /public_api/webhook/{id}/

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

Request

Path parameters

idinteger required

Id do App 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

fieldsunknown
createdAtstring date-time required

Data e hora de criação

updatedAtstring date-time required

Data e hora da última atualização

Changes

No recorded changes to this operation across all 1 revision of this API.