> For the complete documentation index, see [llms.txt](https://docs.askyazi.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.askyazi.com/integrations-and-api/response-push-webhooks.md).

# Response Push webhooks

Send each participant's answers to your own system as they come in, using Response Push webhooks.

Response Push sends a participant's answers to a web address you control (an endpoint) as they are given, so your own system receives responses during fieldwork instead of waiting for an export. It is set per study under **Build > Study configuration > Integrations**.

{% hint style="info" %}
**In short:**

* Yazi sends an HTTPS `POST` with a JSON body, either when a participant completes or after each question.
* Authentication options: bearer token, API key header or basic auth.
* Failed pushes are retried up to three times and stored, so a short outage on your side does not lose data. The packet has a fixed shape and cannot be customised.
  {% endhint %}

## How it works

When a participant answers (or completes, depending on your setting), Yazi builds a JSON packet for that participant and sends it to your endpoint with an HTTPS `POST`. The push runs in the background, so a slow endpoint never delays the participant's next question on WhatsApp.

The in-app description reads: "Push responses to a partner endpoint as they're answered (partial completes)." When nothing is set up, the **Integrations** row shows **No webhook**.

## Before you start

You need:

* An HTTPS endpoint that accepts `POST` requests with a JSON body. Plain HTTP is not accepted.
* A way to authenticate Yazi's requests: a bearer token, an API key header, or a username and password for basic auth.
* An endpoint that replies quickly with a success status (`2xx`) and processes the data afterwards, so a slow reply is not treated as a failure.

## Set it up

<figure><img src="https://358667285-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzMRQUXiGQlBwWdg6WEmG%2Fuploads%2FYmiAFD5ztRRNQzV2g7MI%2Fstudy-configuration-panel.webp?alt=media&amp;token=a51d02a6-c258-48cc-9339-21303bd1138c" alt="The Study configuration panel on the Build tab, with Integrations under Advanced"><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### Open the study's configuration

Go to **Build** and find the **Study configuration** panel on the right. Under **ADVANCED**, click **Integrations**, then **Response Push**.
{% endstep %}

{% step %}

### Enter your endpoint

Paste your HTTPS endpoint address.
{% endstep %}

{% step %}

### Choose authentication

Pick bearer token, API key header or basic auth, and enter the credentials.
{% endstep %}

{% step %}

### Choose when to push

Push when a participant completes, or after every question (partial completes).

<figure><img src="https://358667285-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzMRQUXiGQlBwWdg6WEmG%2Fuploads%2FqiMTMzpAFt0zJs8bOT81%2Ffs-response-push.webp?alt=media&amp;token=2e168d5e-6dac-420c-80b3-1abfbc40d5c8" alt="Study configuration > Integrations: Response Push sends answers to your own webhook URL"><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### Check it works before full fieldwork

Before you send to your full sample, check that your endpoint receives packets and that your system reads every field, for example during a small soft launch.
{% endstep %}
{% endstepper %}

## What the packet contains

Each push carries one participant's data:

| Content                              | Notes                                                                                                                                                         |
| ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Study                                | Which study the response belongs to.                                                                                                                          |
| Participant number                   | The participant's phone number. When Privacy Protection is on, the phone number is withheld. Send a test response to see exactly what your endpoint receives. |
| Every answer, with its question text | All answers given so far, each paired with the question as written.                                                                                           |
| Voice notes and photos               | As links to the media.                                                                                                                                        |
| Location                             | For location questions.                                                                                                                                       |
| Demographics                         | Profile data held for the participant.                                                                                                                        |
| Attempt marker                       | Each delivery attempt is tagged, so you can tell a retry from genuinely new data.                                                                             |

Ask support for a sample packet for your developers to build against.

{% hint style="info" %}
**Fixed shape.** The packet has the same structure for every study and every partner. You cannot rename fields, choose which fields are sent or change the format. Map the fields on your side.
{% endhint %}

## Retries and failed pushes

* Every push is saved before it is sent.
* If your endpoint fails or cannot be reached, Yazi retries up to **3 times**, waiting longer between each attempt.
* If all attempts fail, Yazi's team is alerted and can resend the stored push. Contact support if you think pushes are missing.
* Because a push can arrive more than once (a retry after your endpoint timed out, for example), make your endpoint safe to receive the same packet twice. Use the attempt marker, or the participant and question, to remove duplicates.

## Push after every question versus on completion

|          | After every question                                       | On completion                                      |
| -------- | ---------------------------------------------------------- | -------------------------------------------------- |
| You get  | Partial data as it arrives, including people who drop out. | One packet per finished participant.               |
| Volume   | Many requests per participant.                             | One request per participant.                       |
| Best for | Live dashboards, triggering follow-up actions quickly.     | Loading finished responses into a CRM or database. |

## Limits and things to know

* **Fixed packet shape.** It cannot be tailored per study or per partner.
* **HTTPS only.**
* **Personal data leaves Yazi.** The packet includes phone numbers and demographics. Make sure your endpoint and your data agreements cover this. See [Participant privacy](https://docs.askyazi.com/security-and-privacy/participant-privacy.md).
* **Pushes before 17 September 2026** were sent once with no retry and no stored copy. If your endpoint was down before that date, those pushes cannot be recovered. Use an export to fill gaps.
* **No native Power BI or Tableau connector.** Point your own pipeline at the pushed data, or use [Google Sheets or Excel](https://docs.askyazi.com/integrations-and-api/google-sheets-and-excel.md).

## Related

* [Event triggers API](https://docs.askyazi.com/integrations-and-api/event-triggers-api.md)
* [Google Sheets and Excel](https://docs.askyazi.com/integrations-and-api/google-sheets-and-excel.md)
* [Exports](https://docs.askyazi.com/results-and-reporting/exports.md)
* [Participant privacy](https://docs.askyazi.com/security-and-privacy/participant-privacy.md)
