Actions19
- Plataforma Actions
- Retorno Actions
- Venda Interna Actions
- Webhook Actions
Webhook → Cadastrar Webhook
AI-generatedSummary
Register a new webhook to receive notifications from the Equals platform for a specified event type.
Inputs
- Tipo de Evento (required) — Numeric identifier of the webhook event type to register.
- Endpoint HTTPS (required) — The HTTPS URL that will receive the webhook notifications (must be an HTTPS URL).
- HMAC Secret (required) — Secret key used to sign webhook requests with HMAC authentication.
- Ativo — Activation status of the webhook; either active (1) or inactive (0). Defaults to active.
- Headers Extras (JSON) — Optional additional HTTP headers (in JSON key/value object) to include in webhook notifications; use empty JSON {} if none.
Output shape
a single JSON object with the registered webhook details as returned by the Equals API
Throws an error if the API request fails; the output JSON includes details of the created webhook on success.
Examples
Example 1: Register webhook for event type 10, active, with secure endpoint
idTipoEvento=10, webhookEndpoint='https://example.com/webhook', hmac='secretKey', flagAtivo=1, headersExtra='{"X-Custom-Header":"value"}'