Skip to content
Nappai Documentation

Webhook Response

Webhook Response decides what your flow answers to the application that started it through its webhook. Without this component, whoever calls the webhook immediately receives only a notice that the run has started. With it, the call waits for the flow to finish and gets back, as the answer, the data you connect here.

It is used together with Webhook Input, the component that gives the flow its webhook address.

When to use it

  • Your website sends a form and needs to know right away whether the request was accepted.
  • Another application asks the flow to classify a text and expects the category in the answer.
  • A booking system checks availability and shows the customer what the flow returns.
  • You want to use a flow as your own service that other tools query and get a result from.

Configuration

FieldWhat it does
DataThe data returned to whoever called the webhook. Connect the result you want to send, as it comes out of the previous component.

Output

Data returns the same data it receives. What matters is that this data is the answer the calling application receives.

Example

A clinic receives appointment requests from its website:

  1. Webhook Input receives the patient’s name, the specialty and the preferred date.
  2. An agent checks the schedule and prepares an answer with the proposed appointment.
  3. That answer, as data, is connected to Data in Webhook Response.
  4. The website receives the proposed appointment in the same call and shows it to the patient.

Good practices

  • Keep the flow quick when you use this component: the calling application waits until it finishes.
  • Use a single Webhook Response per flow, so it is clear what is returned.
  • Webhook Input: gives the flow its webhook address and receives the data.