---
title: Sending data to your system (using webhooks)
description: Integrate Josef with webhooks to automate data transfer to other applications. Learn how to set up and utilize webhook URLs effectively.
---

[Skip to content](https://help.joseflegal.com/sending-data-to-your-system-using-webhooks#main-content)

<https://help.joseflegal.com/kb-tickets/new?hsLang=en>

[![Josef Logo](https://help.joseflegal.com/hs-fs/hubfs/josef-logo-4.png?width=120&height=40&name=josef-logo-4.png)](https://www.joseflegal.com)

Open main navigation

Close main navigation

- <https://help.joseflegal.com/kb-tickets/new>
- [Contact us](https://help.joseflegal.com/kb-tickets/new)

[Contact us](https://help.joseflegal.com/kb-tickets/new?hsLang=en)

 How can we help you?

- There are no suggestions because the search field is empty.

1. [Support](https://help.joseflegal.com/?hsLang=en)
2. [Josef No-Code Automation Platform](https://help.joseflegal.com/josef-no-code-automation-platform?hsLang=en)
3. [Integrations](https://help.joseflegal.com/josef-no-code-automation-platform?hsLang=en#integrations)

# Sending data to your system (using webhooks)

You can integrate Josef into your workflows in various ways. 

In this article, we’ll explain how you can use webhooks to send data from Josef bots to other applications that you use. 

Once you have your webhook URL, reach out to us at [support@joseflegal.com](mailto:support@joseflegal.com) with any details (e.g. custom header requirements), and we’ll link it to your bot.  

### **What are webhooks**

Webhooks are one way that Josef sends automated messages, information or documents to other applications.

Webhooks allow you to send real-time data from Josef to another application whenever a specific event occurs. 

Whenever that event occurs, data is sent from Josef to the receiving application that handles the data. Here’s a visual representation of what that looks like:

![Visualisation\_of\_a\_webhook](https://help.joseflegal.com/hs-fs/hubfs/Knowledge%20Base%20Import/Visualisation_of_a_webhook-1.png?width=563&height=279&name=Visualisation_of_a_webhook-1.png)

This exchange of data happens over the web through a “webhook URL.” A webhook URL is a web address provided by the receiving application for Josef to send data to.

One way to understand this is to think about the webhook URL as a phone number that Josef can call when an event happens. 

If the phone number is correct, Josef sends data about the event to the webhook URL in either JSON or XML format. This is known as the “payload.”

### **How you can use webhooks**

By adding a webhook URL to your bot, Josef will send a POST request to the designated webhook in the receiving application, when a specific event occurs.

On Josef, the **event** that triggers this request is a **completed interaction**. 

A completed interaction takes place when a user reaches a **final message** in your bot.

Only when a user reaches a final message will the bot send the payload to the webhook URL. Incomplete interactions – where the user does not reach a final message – will not trigger a request.

### **The payload**

When a **completed interaction** occurs in a bot that is set up to send data to a webhook URL, the data will be sent in JSON format, according to the schema below.

A Josef payload uses the following parameters:

- **“account”** contains information about the user account in which the bot is housed, including the user’s name, email address and the bot styles they use
- **“issue”** contains information about the bot, including its name, the introductory message, and the bot’s universally unique identifier (UUID)
- **“answers”** contains a full record of the interaction, including mapping the messages sent by the bot and the responses given by the user
- **“user documents”** contains URLs for user generated documents

### **Sample payload**

Below is a sample JSON payload that contains data with the “account”, “issue”, “answers” and “user documents” parameters. 

{

    "account": {

        "name": "John Doe",

        "email": "john@example.com",

        "logo": "www.example.com/mylogo.png",

        "avatar": "www.example.com/myavatar.png",

        "main\_color": "#FFFFFF",

        "secondary\_color": "#E2E2E2"

    },

    "issue": {

        "name": "My Josef Bot",

        "introduction": "Hello",

        "uuid": "abcd1234"

    },

    "answers": {

        "Name": "Jane Doe",

        "Date": "2026-04-17T00:00:00.000Z",

        "Email": "Jane@example.com",

        "Address": "123 Example Street, Melbourne",

        "Occupation": "Legal Technologist",

        "Description of request": "Bot interaction completed",

        "Looping message": "First response|Second response|Last response",

         "File Upload": "https://storage.googleapis.com/jsf-production-au-api-storage-bucket-clnu/xxxyyyy/NDA.docx"

    },

    "formatted\_answers": {

       "Date": "April 17, 2026",

       "Bonus" "$1,000.00"

 },

 

 "variables": {

    "Salary": "$100.10",

    "Discount": "10%"

  },

    "save\_progress\_link": "https://au.bot.joseflegal.com/intakebot?case=1a2b3c4d"

    "user\_documents": \[

        "www.joseflegal.com/link/to/document"

    \],

    "uuid": "wjzdhVdRD"

}

- [Josef Q](https://help.joseflegal.com/josef-q?hsLang=en#main-content)

    - [Using tools](https://help.joseflegal.com/josef-q?hsLang=en#using-tools)
    - [Training tools](https://help.joseflegal.com/josef-q?hsLang=en#training-tools)
    - [Preparing a knowledge base](https://help.joseflegal.com/josef-q?hsLang=en#preparing-a-knowledge-base)
    - [Release note (Josef Q)](https://help.joseflegal.com/josef-q?hsLang=en#release-note-josef-q)
    - [Creating tools](https://help.joseflegal.com/josef-q?hsLang=en#creating-tools)
    - [Managing tools and accounts](https://help.joseflegal.com/josef-q?hsLang=en#managing-tools-and-accounts)
    - [Integrations](https://help.joseflegal.com/josef-q?hsLang=en#integrations)
    - [Resources](https://help.joseflegal.com/josef-q?hsLang=en#resources)
    - [Monitoring & maintaining tools](https://help.joseflegal.com/josef-q?hsLang=en#monitoring-maintaining-tools)
- [Josef No-Code Automation Platform](https://help.joseflegal.com/josef-no-code-automation-platform?hsLang=en#main-content)

    - [Building bots](https://help.joseflegal.com/josef-no-code-automation-platform?hsLang=en#building-bots)
    - [Integrations](https://help.joseflegal.com/josef-no-code-automation-platform?hsLang=en#integrations)
    - [Notifications and workflows](https://help.joseflegal.com/josef-no-code-automation-platform?hsLang=en#notifications-and-workflows)
    - [Document creation](https://help.joseflegal.com/josef-no-code-automation-platform?hsLang=en#document-creation)
    - [Managing bots](https://help.joseflegal.com/josef-no-code-automation-platform?hsLang=en#managing-bots)
    - [Testing, troubleshooting and editing](https://help.joseflegal.com/josef-no-code-automation-platform?hsLang=en#testing-troubleshooting-and-editing)
    - [Launching](https://help.joseflegal.com/josef-no-code-automation-platform?hsLang=en#launching)
    - [Single Sign-On](https://help.joseflegal.com/josef-no-code-automation-platform?hsLang=en#single-sign-on)
    - [FAQs](https://help.joseflegal.com/josef-no-code-automation-platform?hsLang=en#faqs)
    - [Getting started on Josef no-code](https://help.joseflegal.com/josef-no-code-automation-platform?hsLang=en#getting-started-on-josef-no-code)
    - [Release notes & FAQs for Josef no-code](https://help.joseflegal.com/josef-no-code-automation-platform?hsLang=en#release-notes-faqs-for-josef-no-code)
    - [Managing accounts](https://help.joseflegal.com/josef-no-code-automation-platform?hsLang=en#managing-accounts)
    - [Reporting](https://help.joseflegal.com/josef-no-code-automation-platform?hsLang=en#reporting)
    - [Formatting a bot](https://help.joseflegal.com/josef-no-code-automation-platform?hsLang=en#formatting-a-bot)

[![Chill listening crop-3](https://help.joseflegal.com/hs-fs/hubfs/Josef%20logo.png?width=72&height=24&name=Josef%20logo.png "Chill listening crop-3")](http://joseflegal.com)

[support@joseflegal.com](mailto:support@joseflegal.com) 

<https://twitter.com/joseflegal/> <https://www.linkedin.com/company/joseflegal/> [mailto:support@joseflegal.com](mailto:support@joseflegal.com)

Copyright © 2025, Josef Legal