Skip to main content

Prerequisites

The connector should already be set up, with a Connector Profile and a Linked Account. See Getting Started on the Vimeo connector page.

How Vimeo webhooks are set up

There is nothing to configure in Vimeo and no URL to copy. For each event you enable in StackOne, StackOne creates a webhook on the Vimeo app this connection uses, and removes it again when the account is disconnected.

  • Vimeo webhooks belong to the Vimeo app, not to a user, and each takes one event type, so each enabled event becomes its own webhook on the app.
  • A Vimeo app holds only one webhook per event type, and it fires for every user of the app. Use a separate Vimeo app for each connected account, or events from other users of the app reach this account.

Before you enable events

Check the Vimeo app and the connection can use webhooks.

  • The Vimeo app needs Vimeo’s webhooks capability. Without it, Vimeo doesn’t send events for the app. See Vimeo’s app webhooks documentation.
  • Add webhooks to the Scopes field when you connect, so Vimeo sends events for this user. It isn’t in the default scopes.

Available webhook events

The following Vimeo events can be enabled. Only events selected in StackOne get a webhook on the Vimeo app, and Vimeo doesn’t send events it has no webhook for.

1

Video events

Events on videos, from creation to transcoding, transcripts, thumbnails and content scans.

  • Video Created (video-created) — Fired when a user creates a video
  • Video Deleted (video-deleted) — Fired when a user deletes a video
  • Video Upload Failed (video-upload-failed) — Fired when a video upload fails. The payload carries the failure cause
  • Video Transcode Playable (video-transcode-playable) — Fired when a video is ready for playback
  • Video Transcode Fully Playable (video-transcode-fully-playable) — Fired when a video is playable in all resolutions, up to the source quality or 4K, whichever is lower
  • Video Transcode Complete (video-transcode-complete) — Fired when a video has finished transcoding
  • Transcript Status Complete (transcript-status-complete) — Fired when a video’s transcript completes or fails
  • Automatic Thumbnail Available (automatic-thumbnail-available) — Fired when the automatically generated thumbnail for an uploaded video is available
  • Content Scan Completed (content-scan-completed) — Fired when a content scan of a video version is complete
2

Live event events

Events on Vimeo live events.

  • Live Event Started (live-event-started) — Fired when a live event goes live
  • Live Event Ended (live-event-ended) — Fired when a live event ends
  • Live Event Updated (live-event-updated) — Fired when a live event is updated
  • Live Event Clip Created (live-event-clip-created) — Fired when a new video is created for a live event
  • Live Event Archive Available (live-event-archive-available) — Fired when the archive of a live event is ready
3

Registration events

Events on registrants of lead-capture resources (live events, videos and showcases). Vimeo sends these as change hints, and a bulk import or delete sends one event rather than one per registrant.

  • Registration Created (registration-created) — Fired when a registrant is added through the registration form or a single API registration
  • Registration Updated (registration-updated) — Fired when a registrant is updated, including when they are blocked or unblocked
  • Registration Deleted (registration-deleted) — Fired when a registrant is removed

Verify

Your Connector should now be able to receive and process events. Try triggering an event and you should see an Event appear in the Connector logs.