Webhook

Product event

​

Gumlet delivers this notification with HTTP POST and a JSON body to the webhook URL you configured. The x-gumlet-token header is the secret token stored on that webhook, or an empty string when none is stored. A response status from 200 through 299 is recorded as success. Any other status, a timeout, or a connection error is recorded as retrying. Gumlet waits up to 25 seconds for the response and follows up to 5 redirects.

Sent when the webhook trigger list contains the exact event name. event.video.analytics is matched against the webhook's video workspaces. event.image.analytics is matched against its image sources. Every other event is matched against the video workspace list. An empty list matches every workspace or image source in the organization.

The body is the originating event payload. Gumlet sets type to the event name before delivery.

Events:

  • event.video.uploaded — a video was uploaded
  • event.video.updated — video details changed, such as title, tags, description, or privacy
  • event.video.analytics — video analytics event
  • event.image.analytics — image analytics event
  • event.embed.viewed — an embed was viewed for the first time
  • event.embed.cta_clicked — a call to action was clicked on an embed
  • event.embed.form_submitted — an embed form captured a lead
  • event.playlist.created — a playlist was created
  • event.playlist.asset — an asset was added to or removed from a playlist
  • event.playlist.deleted — a playlist was deleted
  • event.comment.all — a comment was added, replied to, or resolved
  • event.channel.member_joined — a viewer joined a channel

Headers

  • x-gumlet-token
    Type: string
    required

    Secret token configured on the webhook. Compare it with the token you stored when creating the webhook. The value is an empty string when the webhook has no secret token.

Body·

required
application/json

Body posted for event.* notifications. Gumlet forwards the originating event payload and sets type to the event name. Other properties depend on the event and are passed through unchanged.

  • type
    Type: stringenum
    required

    Product event that triggered this delivery.

    values
    • event.embed.viewed
    • event.embed.cta_clicked
    • event.video.updated
    • event.video.uploaded
    • event.playlist.created
    • event.playlist.asset
    • event.playlist.deleted
    • event.video.analytics
    • event.image.analytics
    • event.embed.form_submitted
    • event.comment.all
    • event.channel.member_joined
  • propertyName
    additionalPropertyType: anything

Responses

  • 2XX

    Acknowledge delivery. Any status from 200 through 299 is treated as success. Any other response is recorded as retrying.

Request Example for postproductEvent
{
  "type": "event.video.uploaded"
}
No Body

Acknowledge delivery. Any status from 200 through 299 is treated as success. Any other response is recorded as retrying.