What is a Webhook and how to use it?

Zight Webhooks enable organizations to integrate Zight seamlessly with external tools, enhancing workflow automation, data sharing, and operational efficiency.

Zight offers many direct integrations, and our shareable links also help make sure you can add your videos and other captures in any tool. Another type of integration is via webhooks, which are a way to get notified when a certain action happens in your Zight organization.

So what exactly is a webhook?

A webhook is a way for an app to provide other applications with real-time information. In our case once you add your webhook URL under your account settings, we will send near real-time information for these events.

Webhooks are managed at the organization level. At this time, only one webhook URL can be called, with many events. This helps you centralize its management, and you can then define the logic and destination of the content in other tools like Zapier.

Common use cases

• Content Organization: Automatically sync Zight items with external folders (e.g., Google Drive) when added to a collection, reducing manual updates.
• Support Efficiency: Send request video submissions directly to Zendesk tickets for seamless troubleshooting.
• Custom Data Posting: Use webhooks to send data to external systems like Zapier for further automation or custom workflows.
• Content Publishing: Publish videos directly to YouTube, TikTok, or other platforms via webhooks. For example, you can create a collection called "Youtube" that auto-uploads your Zight videos to Youtube when added.
• Meeting Management: Upload Zoom/Google Meet recordings to Zight, generate shareable links, and save to collections automatically.

Available Zight Webhooks

Webhook: "item_created"
Triggered by: owner
Description: triggered when the item is created. This means the item was created in our system, but doesn't mean it's done processing or being uploaded so it doesn't have all the item info
Use cases: track items created in your organization

payload: {
item_name: the item's name
item_url: the item url
created_at: item creation date
}

Webhook: "added_to_collection"
Triggered by: owner
Description:
Use cases: perform specific actions when an item is being added to a collection. Useful for automatically sending it to a specific tool (ex: Youtube collection sends your content to Youtube, while Google Drive collection sends the video to Google Drive).
When you use our "Request video" feature, this event is also being triggered when you receive a video, so you can send the received videos to your own CRM.

payload: {
        collection_name: The collection's name
        collection_url: The collection's shareable url
        item_url: The item's shareable url (usually share.zight.com/123456)
        created_at: Time the webhook was triggered
        item_type: The type of content captured: Video (vi), Screenshot (sc), File upload (fu), Gif (gi) etc.
        name: The item's name
        view_counter:  Current views at the time the action is being triggered
        content_url: Direct link to the item's url. Warning: this url doesn't follow Zight's security settings
        description: item.description,
        email: Email of the owner
        transcription: Transcription (only available when the AI addon is enabled)
        request_custom_id: The custom id if the item was added to a "request video" collection.
      })

Coming soon:

Webhook: "smart_action_triggered"
Triggered by: owner of the item
Description:
Use cases: Perform a specific action when a smart action gets triggered. Ex: Bug report goes to Jira

payload: {
      smart_action_body: The smart action content. Usually the description
      smart_action_name: Name of the action?
      item_url: The item's shareable url (usually share.zight.)
      item_type: The type of content captured: Video (vi), Screenshot (sc)
      name: The item's name
      view_counter: Current views at the time the action is being triggered
      content_url: The url of the actual content
      description: The description of the item. If AI is enabled, this is the summary of the video
      email: the email of the owner
    })

Here are some steps for how you can set up your webhook in Zight:

• You’ll need to add your webhook URL, which you can get by creating a new ‘Zap’ in Zapier called ‘Catch Hook’.
• After you copy the webhook URL and save it into Zight, test to make sure that the webhook is sent correctly from Zight to Zapier.

And that's it! You can now create Webhooks and share wherever you’d like. This is the first version of Webhooks. Let us know what you would like to see in upcoming versions or if you need help solve a specific workflow.

We also plan to have a direct Zapier integration soon to make this easier.

Example workflows

To manage webhooks, you have multiple options. One of the easiest one to setup is by using a tool like Zapier, which you can then connect to hundreds of other tools.

Below are some common step by step scenarios:

1. Requested videos to your CRM (via Zapier)

With Zight’s new “Request video” feature, you can create a unique link per ticket to send to your customers so they can record what they are seeing on their screen and avoid unnecessary back and forth. Videos recorded by your customers will be sent back to your your Zight account, and using a webhook will allow you to get notified in your CRM of choice (here, we’ll use Zendesk).

For more information about request video, see here : insert request video link

Step 1: Setup Zapier

• Once you have created your Zapier account, create a new Zap

• Select “trigger” - Here

• Select “webhooks” - Here

• A panel will open to let you customize the trigger, select “Catch Hook” - Here

• You do not have to set a child key - Here

• You should now have a webhook URL you can copy - Here

Step 2 : Adding the webhook in Zight

• In Zight, navigate to the settings, then “Integrations”. You need to be an admin on your organization to continue.

• In the Webhook URL input, paste the Zapier webhook.

• Click “Update webhooks.”

Step 3: Setup your Zapier destination

• In Zapier, you should now receive webhooks in the trigger

• You can test the hook by adding a video to a collection and clicking on “find new records”, select the request that you want, which will let you create more steps with real data.

  • In the path conditions, you should add condition to make sure the video added to a collection is part of a request link

  •  

• You can now add many destinations, including Zendesk by clicking on “Action”

• Add your account under “Select an account”.

• For the Action even, select Add Comment to Ticket

• Note that if you want others to be able to publish your webhook, you need to make this Zendesk step shared with your team:

• When configuring the Zendesk Zapier integration, you can now add the payload info you want from the ticket (link to the video, ticket number etc). More info coming soon!

• Publish it, and you should be all set! 🥳

2. Send videos/screenshots/files to Google Drive

Following the steps 1-2 above, you can just select Google Drive as your destination, like so:

Make sure the file references the “payload content url”

Note: Make sure you set up the necessary rules on your Google Drive if you send sensitive information.

3. Send videos to Youtube

Following the steps 1-2 above, you can just select Youtube as your destination, like so:

Related articles

• Zight Record SDK | Embed Zight in Your Product
• What are the tools Zight integrates with?
• Where is my data stored? Where is my data hosted?
• How do I setup a branded URL / custom domain and SSL/HTTPS?
• How to Download Zight Files