Getting Started with Webhooks

Getting Started with Webhooks

One of the many ways that Mediagraph integrates with other apps is through the use of webhooks. Mediagraph can use webhooks to automatically send information to other apps when something new happens. A webhook is triggered under specific and designated circumstances, such as when a new file is uploaded or added to a specific container. Most webhook integrations with Mediagraph will make use of a webhook client called Zapier. Zapier helps forward information from Mediagraph to other web apps.

Let's take a close look at one example of a webhook integration to learn more about how they work.

One of the uses for webhook integration, as shown in the diagram below, is to send an automatic Slack message any time a new file is uploaded or added to a designated container in Mediagraph.

diagram.001.jpeg

Each webhook communication consists of three parts: a trigger event, payload and an action.

In this case, the upload of the new file is the trigger event. When Mediagraph sees the new file come in, it sends a message in the form of an HTTP request to a unique URL provided by Zapier. This message contains information about the file, referred to as the payload. After Zapier receives the message, an action takes place according to a protocol chosen during setup. In this example, Zapier selects and formats some of the information from the payload and forwards it to a Slack channel.

All this occurs instantaneously each time a new file is added to the Mediagraph container selected during setup. This is just one example of an integration possible with webhooks. 

Mediagraph supports a number of different trigger events. Webhooks must be connected to a specific container in Mediagraph: a Storage Folder, Collection, or Lightbox. Any time a new asset is added to the container, information about the asset is sent. Source containers may be chosen to trigger a webhook under many different circumstances.

Some examples of events that can trigger a webhook are:

  • A new file has been uploaded by a specific user, or a member of a specific user group.
  • A file has been moved into a Lightbox or Collection designated to trigger a webhook integration.
  • A new file has come in through a contribution request.
  • A file reaches a certain stage in an approval workflow.
  • A new file has been shared with you.

When Mediagraph sends a webhook, the payload includes rich data about the asset that triggered it.

Payload data includes:

  • The identity of the user who added it to the container (name username, and user ID).
  • File name and location.
  • Download URLs for full size (optional), 1200px-downsized, and a thumbnail.
  • All other metadata, including all Tags and information about their location in the Tag Tree.

    • Related Articles

    • Getting Started for Managers

      Source: https://damsoftware.zendesk.com/hc/en-us/articles/6489809109396-Getting-Started-for-Managers
    • Getting Started with Workflows

      Mediagraph allows you to set up workflows, multi-step processes that can achieve many different objectives. Standardizing and automating steps with workflows is a great way to increase the ease and efficiency of processes you and your organization ...
    • Getting Started with Access Requests

      Access requests are an easy way to control and track the use of assets by members of your organization and others. When access requests are enabled, users with permission to view assets can in order to download them. When requesting access, a user ...
    • Getting Started with Face Tagging

      Welcome to MediagraphAI face tagging! We think you’ll find it does a very good job of identifying faces. It should save you a lot of time, and help you discover hidden content in your media collection. The guide here is a work in progress. We’re ...
    • Getting Started with Quick Upload

      In today’s connected world, crowdsourcing media is more important than ever. Quick Upload streamlines the process of gathering media from your community, enabling efficient crowdsourcing directly into your organization’s account. A lightweight, ...