Skip to content
Nappai Documentation

Webhook Response

The Webhook Response component lets you send data back to a webhook that triggered your workflow. It takes the data you want to return and outputs it so the external system receives it.

How it Works

When a webhook request arrives, the workflow can process the data however you need. The Webhook Response component simply takes whatever data you provide, stores it as its status, and returns that same data. No external API calls are made; everything happens locally within the workflow.

Inputs

Input Fields

  • Data: The data you want to send back to the webhook. This can be any format that the receiving system expects (e.g., JSON, plain text, or a structured object).

Outputs

  • Data: The same data that was supplied to the input, ready to be sent back to the webhook. Connect this output to the component that actually sends the HTTP response.

Usage Example

  1. Webhook Trigger – A webhook request arrives and passes its payload to the workflow.
  2. Processing – Add any components you need to transform or enrich the data.
  3. Webhook Response – Connect the processed data to the Data input of the Webhook Response component.
  4. Send Response – Connect the Data output to the component that sends the HTTP response back to the original caller.

This setup allows you to acknowledge the webhook request with a custom message, status code, or any other data the external system expects.

  • Webhook Trigger – Starts the workflow when a webhook request is received.
  • Webhook Request – Sends a webhook request to an external service.
  • HTTP Response – Sends an HTTP response back to the caller (often used in conjunction with Webhook Response).

Tips and Best Practices

  • Match the Expected Format: Ensure the data you send back matches the format the webhook expects (JSON, XML, plain text, etc.).
  • Use Structured Data: When possible, send structured data (e.g., JSON) so the receiving system can parse it easily.
  • Validate Sensitive Information: If the webhook response contains sensitive data, make sure it is encrypted or masked before sending.
  • Test with a Sandbox: Use a testing environment to verify that the response is correctly received by the external system.

Security Considerations

  • Data Exposure: The component simply forwards data; it does not add encryption. If the data is sensitive, ensure it is transmitted over HTTPS and consider encrypting the payload before sending.
  • Authentication: If the webhook requires authentication, make sure the workflow includes the necessary authentication steps before sending the response.
  • Rate Limits: Be aware of any rate limits imposed by the external system to avoid being blocked.