Visual Experience Platform
Help CenterRelease NotesBlogWebsite
  • VXP - Visual Experience Platform
    • The VXP
      • Token
    • Settings
      • My Account
        • Profile
        • Support
      • Organisation
        • General Organisation Settings
        • Billing
          • Payment
          • Invoices
          • Plan
        • Users
          • Users
          • Roles
        • Teams
      • Project
        • Branding
        • Subscription
        • Analytics
          • Standard Dashboards
            • Multi tenants
            • User Dashboard
            • DAM Storage
            • Workflows Monitoring
            • Traffic Origin
            • Caching (Volumetry)
            • CDN performance
          • Custom Dashboard
        • Access
          • API keys
          • Security templates
          • OAuth2
  • Digital Asset Management (DAM)
    • Library
      • Assets
        • Asset Details window
          • Asset actions
            • Regional settings
            • Context menu ("..." button)
            • Add to My favorites (heart icon)
            • Edit media (image, video, etc)
              • Edit image
              • Edit video
              • Edit design template (coming soon)
            • Share
          • Asset information tabs
            • General
            • Metadata
            • Variations
            • Comments
            • Approvals
            • History
      • Folders
      • Collections
      • Labels
      • Products
      • My favorites
      • Help
      • Sharebox
      • Airbox
      • Search and Filters
        • Faceted Search
    • Plugins & Connectors
      • Plugins
        • Adobe Creative Cloud
        • Adobe Commerce (Magento)
        • Canva
        • Contentful
        • Contentstack
        • Directus
        • Drupal
        • Opencart
          • Opencart (v4)
        • Prestashop
        • Shopware
        • Storyblok
        • Strapi (v4)
        • Sylius
        • Uniform CMS
        • Wordpress
      • Connectors
        • Akeneo PIM App
        • Canva App
        • CI-Hub
        • Commercetools FaaS App
        • Hygraph app
        • Kontent.ai
        • OneTeg
        • Pabbly Connect
        • Prismic
        • Shopify / Shopify plus app
        • Zapier automation
    • Settings
      • Library
        • Components
        • Appearance
      • Metadata
        • Metadata Configuration
        • Assets
      • Tags
        • Configuration
        • Dictionary
      • Notifications
      • Automations
        • Post processing
        • Webhooks
        • Workflows
      • Storage
        • Providers
        • Upload
        • Video
        • Listing
        • Retrieval
        • Custom routing
  • Visual AI
    • Welcome
    • Visual AI
      • Images
        • Classification models
          • Auto-tagging
          • Brand detect
          • Dominant color extraction
          • Faces
            • Face analysis
            • Face clustering
          • Image quality
          • OCR
          • Number Plate recognition
          • Product type
          • Property classification
          • Scene Classification
          • Sport Classification
        • Generative AI models
          • Image-to-text
          • Plate blurring
          • Quality improvement (remove artifacts)
          • Remove background
          • Text-to-Image
        • Moderation models
          • Face count
          • NSFW - Not Safe For Work
          • Real estate authenticity
          • Watermark detection
      • Videos
        • Face detection
      • Search & find assets
        • Text Search
        • Similar Assets
  • Portals
    • Welcome
    • Creating a Portal
    • Editing a Portal
      • Pages
      • Sections
      • Design
      • Fonts
    • Managing a Portal
      • Settings
      • Access
      • Users
      • Labeling, Cloning, Archiving
    • Publishing a Portal
  • Dynamic Media Optimization (DMO)
    • Welcome
      • Responsive libraries
      • Native plugins
      • 360° view builder
      • Service status
    • Insights
      • Delivery
      • Optimization
      • Alerts
      • Logs
    • Transformations
      • Image optimization
        • Operations
          • Width and height
          • Prevent enlargement
          • Crop
            • Automatic Gravity Crop
            • Positionable Crop
            • Focal point Crop
            • Face Crop
            • Face hide
            • Aspect ratio crop
          • Fit
          • Cropfit
          • Bound
          • Boundmin
          • Cover
          • Device pixel ratio
          • Flip
          • Rotate
          • Trim
          • Rounded corners
        • Filters
          • Adjustment
            • Brightness
            • Contrast
            • Saturate
          • Color manipulation
            • Color overlay
            • Grayscale
            • Duotone
            • Sepia
            • Invert
          • Blur
          • Pixelate
          • Sharpen
        • Watermarking
          • Static watermark
          • Dynamic watermark
          • Text watermark
        • Image compression
          • Image formats
          • Optipress
      • Video optimization
        • Video API
          • Editing
            • Chapters
            • Combine
            • Trim
          • Optimizing
            • Convert
            • Compress
            • Transcode
        • On-the-fly-video optimization
      • Static content optimization
        • PDF to image
        • JS/CSS optimization
    • Invalidation
    • Settings
      • Asset Origin
        • AWS S3 or any other S3-compatible storage provider
        • Google Cloud storage (GCP)
        • Azure Blob storage
        • Own HTTP-based Storage
      • Images
        • Compression
        • Options
        • Watermark
      • Static content
      • Delivery
        • CNAME
        • URL format
        • Rules
        • Security
        • Caching
        • Default behaviors
  • Developers / Headless
    • Headless DAM
      • DAM APIs
        • API Authentication
        • API Reference
      • Command Line Interface (CLI)
      • Media Asset Widget(MAW)
        • Overview
        • Developer reference
        • V2 End-of-life
Powered by GitBook
LogoLogo

Quick links

  • Go to website
  • Legal Center

©2024 Scaleflex SAS

On this page
  • Webhook parameters:
  • Connection
  • Authentication
  • Custom headers
  • Triggers
  • Asset triggers
  • Metadata triggers
  • Data to sent
Export as PDF
  1. Digital Asset Management (DAM)
  2. Settings
  3. Automations

Webhooks

Webhooks allow you to call a third-party web service upon specific triggers and send all asset data in the JSON body.

PreviousPost processingNextWorkflows

Last updated 3 days ago

The Webhooks can be accessed from the Settings > Library > Automations > Webhooks menu.

You can add up to 5, individually configured and activated, webhooks.

Webhook parameters:

Webhook parameter
Description

Webhook url

Target webhook url to POST event to

Hostname

The domain address of the third party service where to post data

Path

The domain path to post data to

Basic Authentication

Requires a Username and a password

oAuth2 Authentication

Requires an authentication endpoint (with https://), a username and a password

Connection

To set up the webhook, the following information must be provided:

  • Hostname - The domain name of the third-party API that will be contacted.

  • Path - The specific path with the Hostname forms the complete target URL (Webhook URL) to which the data will be sent.

Authentication

A consumer cannot always verify that the webhook it receives is coming from the expected source. Due to this, there are two authentication methods supported:

  • Basic authentication - The simplest way to verify a webhook. It makes use of a username and a password that are used for authentication when sending the data to the Webhook URL.

  • OAuth2 authentication - A more secure and complex authentication method that allows users to grant limited access to their resources without exposing their credentials. This type of authentication can be used in two ways:

    • By specifying the Authentication endpoint, username and password to retrieve a temporary token, which is then used in the webhook.

    • By directly entering the Static bearer token to use every time without generating a temporary one before the request.

Custom headers

You can specify up to 10 additional headers to be sent to the endpoint with the payload. Those headers will have the classic form name:value:

Triggers

The triggers determine the events that need to happen to execute the webhook. The following ones are available:

Asset triggers

  • On upload - After a successful asset upload.

  • On move - When the asset location is changed.

  • On rename - When the asset is renamed.

  • On delete - When the asset is deleted.

Metadata triggers

  • On change meta - When some specific (or any) metadata field is modified to a value (or any).

  • On change info - When some asset's information (e.g. title, description, etc.) is changed.

  • On change tag - When the asset's tags are edited.

  • On change label - When the asset's labels are modified.

Data to sent

There is fine-grained control over which specific asset details are sent as part of the request JSON body to the selected API endpoint. This ensures that only the necessary information to handle the event effectively is communicated. Those details are divided into several categories depending on the asset type:

File (All assets)
Video
Image
Additional

Name

Width

Width

All system metadata*

Size

Height

Height

All custom metadata*

Path

Length (in seconds)

All embedded metadata*

MIME type

Bitrate

CDN link

HLS/DASH playlist URL

File UUID

* those global metadata packages to send along will include everything that is recorded for the asset in each of the 3 categories.

eg. for system metadata, it includes the file hash, labels, etc.

Note that for embedded metadata, it can be very voluminous, please only add if really necessary.