Is there any callback or web-hook when the processing is finished ? #120

shammi-hak · 2019-10-28T07:17:44Z

I uploaded the video to Vimeo and it succeeds. but when I using the URL, It seems like the video still processing that video. So Is there any callback or web-hook to notified me back when it finished the processing.

unicornsoftwareinc · 2019-11-05T20:34:28Z

Paying business user here and I definitely agree a webhook for when videos are done processing would be really, really helpful.

With the way the API works currently, I have to continually poll the Vimeo API until the video is done processing. I really don't think this is optimal.

fweffort · 2019-11-16T17:40:43Z

same here... this is not cost effective even for vimeo. lots and lots of users pinging their server

Tariqali13 · 2020-01-11T07:05:34Z

any solution found on this?

pavanjadhaw · 2020-04-12T04:37:24Z

@Tariqali13 what I suggest doing is as soon as video is uploaded create db entry for that uri with status of "in_progress"
then run a cronjob every minute what you do in cronjob is
check db for any videos which are of status "in_progress"
make get request to https://api.vimeo.com/me/videos?fields=uri,transcode.status
and map the response to object and update the "in_progress" docs with new status which might be "in_progress", "complete" or "error"

const unprocessedSnapshot = await admin
	.firestore()
	.collection('videos')
	.where('status', '==', 'in_progress')
	.get();

const unprocessedDocs = unprocessedSnapshot.docs;

if(!unprocessedDocs.length) return null;

const response = await axios(
	'https://api.vimeo.com/me/videos?fields=uri,transcode.status',
	{
		headers: { Authorization: 'bearer 4e01e30bfyouraccesstokenhere7013642b6' },
	}
);

interface MapInterface {
	[key: string]: {
		status: string,
	}
}

const map: MapInterface = {};

for (const item of response.data.data) {
	map[item.uri] = {
		status: item.transcode.status,
	};
}

for (const doc of unprocessedDocs) {
	const video = doc.data();

	await admin
		.firestore()
		.collection('videos')
		.doc(doc.id)
		.update({
			...map[video.uri]
		});
}

Tariqali13 · 2020-04-12T07:44:45Z

@pavanjadhaw thanks. that's a good solution but hope in future we will get a callback by vimeo

fweffort · 2020-07-04T11:30:09Z

I bet that if Vimeo wants, a lot of coders would help to implement the webhook feature. I would.
This is sooooo needed.

And again. Lots of “pinging” on the server versus one call to the webhook would unclutter services.

unicornsoftwareinc · 2020-10-21T18:34:49Z

Can anyone from Vimeo comment on this? This feature would really be enormously helpful.

top-kat · 2020-11-18T09:13:40Z

Hi, i have found that bit of undocumented useful code while browsing the repo examples:

client.upload(
  filePath,
  params,
  function (uri) {
    // UPLOAD SUCCESS but NOT TRANSCODED
    // Get the metadata response from the upload and log out the Vimeo.com url
    client.request(uri + '?fields=link', function (error, body, statusCode, headers) {
      if (error) return console.error('There was an error making the request.')
      console.log('"' + filePath + '" has been uploaded to ' + body.link)

        // Make an API call to see if the video is finished transcoding.
        client.request(
          uri + '?fields=transcode.status',
          function (error, body, statusCode, headers) {
            if (error) return console.error('There was an error making the request.')
            console.log('The transcode status for ' + uri + ' is: ' + body.transcode.status)
          }
        )
      })
    })
  },
  function (bytesUploaded, bytesTotal) {  },
  function (error) { }
)

You can start from this example to find a way to check for uploaded AND transcoded status for the video ^^

algosoftbd · 2021-03-16T16:08:45Z

Hi, i have found that bit of undocumented useful code while browsing the repo examples:

client.upload(
  filePath,
  params,
  function (uri) {
    // UPLOAD SUCCESS but NOT TRANSCODED
    // Get the metadata response from the upload and log out the Vimeo.com url
    client.request(uri + '?fields=link', function (error, body, statusCode, headers) {
      if (error) return console.error('There was an error making the request.')
      console.log('"' + filePath + '" has been uploaded to ' + body.link)

        // Make an API call to see if the video is finished transcoding.
        client.request(
          uri + '?fields=transcode.status',
          function (error, body, statusCode, headers) {
            if (error) return console.error('There was an error making the request.')
            console.log('The transcode status for ' + uri + ' is: ' + body.transcode.status)
          }
        )
      })
    })
  },
  function (bytesUploaded, bytesTotal) {  },
  function (error) { }
)

I found this could be useful ^^

Sorry to say, but you didn't understand the problem

unicornsoftwareinc · 2021-06-24T20:15:55Z

Been a paying business user for about 2 years now and still no solution for this yet. I still have my polling solution in place but it would really be so much better if Vimeo implemented some sort webhook/callback feature here.

iSeiryu · 2021-08-27T21:06:57Z

A webhook is available by default in a lot of services nowadays. It'd be very useful to be notified by Vimeo if a video was uploaded/changed. We could even pay a bit extra for this feature (although it should not put too much toll on their systems).

In my case I'd like to keep my custom apps and their service in sync. So, for example, whenever something happens to a video via Vimeo's UI my app would be notified so it could do additional processing.

Wondering if there is a way to make this more visible to Vimeo since it's not javascript specific.

unicornsoftwareinc · 2021-10-01T00:07:35Z

Not sure but to be honest I am considering switching video hosting services. This library seems completely abandoned at this point and video uploads are an important feature for my business. It would be nice to know that the library I am using (as a paying customer) is at the very least being maintained.

2023 edit:
Our business switched over to using Bunny.net which has a really easy to use API for video uploads and management. And as an added bonus, it’s 5 - 10x cheaper compared to the enterprise plan that Vimeo forced us onto a few years ago.

rubenheymans · 2022-06-25T23:04:05Z

are there any updates on this? also what would be a good alternative to Vimeo? Dev support is more important than price
EDIT: I'm using mux, it's great and does support webhooks

iSeiryu · 2022-07-07T14:38:08Z

@rubenheymans Azure Media Services is a good product. It gives more control over the process but is more complex to setup. It also came out cheaper (for our project) than Vimeo. And Azure support is good.
https://azure.microsoft.com/en-us/services/media-services/

aaronm67 · 2022-07-19T14:40:11Z

Currently the only way to view when a video completes transcoding is by polling, i.e. GET /videos/{video_id}?fields=status

If you'd like to see a Webhook interface, please request it at:

https://vimeo.com/help/contact

karlhorky · 2022-07-21T11:44:24Z

Since this status field appears to be undocumented (or hidden somewhere in the API docs that I could not find after looking for 10 minutes), here is the TypeScript type of the response body that you would get from there, scraped together from some 3rd-party Java docs:

// GET /videos/{video_id}?fields=status

type VimeoVideoStatusResponse = {
  status:
    | 'available'
    | 'quota_exceeded'
    | 'transcode_starting'
    | 'transcoding'
    | 'transcoding_error'
    | 'uploading'
    | 'uploading_error';
};

aaronm67 · 2022-07-21T12:18:12Z

status is documented here: https://developer.vimeo.com/api/reference/response/video, if you scroll down about half the page you'll see it / what each state means.

karlhorky · 2022-07-21T12:19:21Z

Workaround

In case this is useful for anyone else, polling using a recursive async function that calls GET /videos/{video_id}?fields=status and then only resolves once an error occurs or the transcoding is done could be done like this (TypeScript):

// Docs: https://developer.vimeo.com/api/reference/response/video#:~:text=available%20%2D%20The%20video%20is%20available.,an%20error%20in%20uploading%20the%20video.
export type VimeoVideoStatus =
  | 'available'
  | 'quota_exceeded'
  | 'total_cap_exceeded'
  | 'transcode_starting'
  | 'transcoding'
  | 'transcoding_error'
  | 'unavailable'
  | 'uploading'
  | 'uploading_error';

/**
 * Get the transcode status of a Vimeo video
 */
export function getStatusByVideoIdRecursive(videoId: number): Promise<
  | {
      errors: Errors,
    }
  | {
      status: VimeoVideoStatus,
    },
> {
  return new Promise((resolve, reject) => {
    client.request(
      `/videos/${videoId}?fields=status`,
      (error, response: { status: VimeoVideoStatus }) => {
        if (error) {
          return reject(error);
        }

        if (['transcode_starting', 'transcoding'].includes(response.status)) {
          return resolve(
            new Promise((resolveInner) => {
              setTimeout(
                () => resolveInner(getStatusByVideoIdRecursive(videoId)),
                1000,
              );
            }),
          );
        }

        resolve({
          status: response.status,
        });
      },
    );
  });
}

karlhorky · 2023-07-31T09:55:26Z

Here's an updated version of the script above, using @vimeo/[email protected] with the promises API:

Is it possible to track the % of the video transcoded #104 (comment)

fweffort · 2024-11-04T10:55:06Z

My opinion:
We have been asking for this webhook for ages... AGES!
We have several people willing to do this for free for vimeo... including me...

We KNOW this is better for VIMEO and for us.

The issue here is: It is not an issue for vimeo! Why? Because we are too kind!
If every single person using this api would poll non stop for transcoding status instead of waiting 1-3 or even 5 seconds, then, and only then, there is a problem for them to fix and work on, otherwise, it's not a problem and it's not priority(clearly)!

C'mon devs @ vimeo...

aaronm67 · 2024-11-04T16:33:45Z

@fweffort If you reach out to support (https://vimeo.com/help/contact) you can be opted in to the webhooks beta.

karlhorky · 2024-11-08T21:51:27Z

@aaronm67 thanks for the tip! Wasn't aware there was a webhooks beta.

Here's how I submitted the form, not sure if you would suggest doing it differently:

Instructions:

Go to https://vimeo.com/help/contact
Log in to your account if necessary
Select the product "vimeo.com"
Select the feature "Uploading and conversion"
Select the feature "Uploading from another website or program"
Select the severity "Minor issue"
Fill in the text fields as follows

Subject:

Opt in to webhooks beta

Description:

Hello,

As Aaron Marasco mentioned on https://github.com/vimeo/vimeo.js/issues/120#issuecomment-2455175223 , I would like to opt our account into the webhooks beta.

Cheers, Karl

karlhorky · 2024-12-19T15:07:42Z

Btw, finally got access to Vimeo App Webhooks beta

(after being bounced back and forth for 1.5 months between different Vimeo support people, some of who were unaware of the App Webhooks feature 😅 so keep in mind that you may also have this experience, if you try it)

karlhorky · 2024-12-19T15:21:25Z

Haven't tried Vimeo App Webhooks yet, so can't say with 100% certainty whether it works well or not yet, but one thing that seems to be missing in the docs from a quick glance is webhook URL app handling / failure cases when responding to a webhook event request from Vimeo, eg:

What happens when the app at the webhook URL (the app receiving the webhook) is unavailable?
1. Are there retries performed? How many? Is this configurable?
2. Is the request "saved" to be delivered on-demand later?
What happens when the app at the webhook URL is available but does not process the request correctly and does not send a response?
1. Probably similar sub-points to above - is this event retried or saved somehow? Or just lost?

If the event request is not retried and the event data is not saved, then it seems like some kind of robustness will need to be built into all webhook URL apps which accept responses from Vimeo. And probably the polling will also need to remain as a fallback.

karlhorky · 2024-12-19T15:32:19Z

@aaronm67 if there's a better place for public feedback to the App Webhooks beta, then happy to write my comments there instead.

aaronm67 · 2024-12-19T15:58:04Z

@karlhorky this works! the product owner will have eyes on this. You can also give private feedback via support and it will be routed as needed.

What happens when the app at the webhook URL (the app receiving the webhook) is unavailable?

In the current beta, we don't retry. I can't give an exact timeline on when we will start, but will just say there's ongoing work. The exact # of times a retry will occur, and how quickly, and how reporting in these cases will occur is still being defined.

Is the request "saved" to be delivered on-demand later?

In a way, the request is saved - it is still being defined how exactly to expose this. So there is no API to access that data at this time - in the current beta, you can treat this as "lost", and since you're signed up for the beta you'll receive product updates at a later time.

If the event request is not retried and the event data is not saved, then it seems like some kind of robustness will need to be built into all webhook URL apps

Yes, most of our webhooks beta customers have these webhooks call into a queue of some sort, so the robustness is provided on your client rather than the webhook service.

aaronm67 added the enhancement label Oct 15, 2021

karlhorky mentioned this issue Jul 21, 2022

Is this project abandoned? #142

Closed

karlhorky mentioned this issue Jul 31, 2023

Is it possible to track the % of the video transcoded #104

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Is there any callback or web-hook when the processing is finished ? #120

Is there any callback or web-hook when the processing is finished ? #120

shammi-hak commented Oct 28, 2019

unicornsoftwareinc commented Nov 5, 2019

fweffort commented Nov 16, 2019

Tariqali13 commented Jan 11, 2020

pavanjadhaw commented Apr 12, 2020 •

edited

Loading

Tariqali13 commented Apr 12, 2020

fweffort commented Jul 4, 2020

unicornsoftwareinc commented Oct 21, 2020

top-kat commented Nov 18, 2020 •

edited

Loading

algosoftbd commented Mar 16, 2021

unicornsoftwareinc commented Jun 24, 2021

iSeiryu commented Aug 27, 2021

unicornsoftwareinc commented Oct 1, 2021 •

edited

Loading

rubenheymans commented Jun 25, 2022 •

edited

Loading

iSeiryu commented Jul 7, 2022

aaronm67 commented Jul 19, 2022

karlhorky commented Jul 21, 2022 •

edited

Loading

aaronm67 commented Jul 21, 2022

karlhorky commented Jul 21, 2022 •

edited

Loading

karlhorky commented Jul 31, 2023 •

edited

Loading

fweffort commented Nov 4, 2024 •

edited

Loading

aaronm67 commented Nov 4, 2024

karlhorky commented Nov 8, 2024

karlhorky commented Dec 19, 2024 •

edited

Loading

karlhorky commented Dec 19, 2024

karlhorky commented Dec 19, 2024

aaronm67 commented Dec 19, 2024

Is there any callback or web-hook when the processing is finished ? #120

Is there any callback or web-hook when the processing is finished ? #120

Comments

shammi-hak commented Oct 28, 2019

unicornsoftwareinc commented Nov 5, 2019

fweffort commented Nov 16, 2019

Tariqali13 commented Jan 11, 2020

pavanjadhaw commented Apr 12, 2020 • edited Loading

Tariqali13 commented Apr 12, 2020

fweffort commented Jul 4, 2020

unicornsoftwareinc commented Oct 21, 2020

top-kat commented Nov 18, 2020 • edited Loading

algosoftbd commented Mar 16, 2021

unicornsoftwareinc commented Jun 24, 2021

iSeiryu commented Aug 27, 2021

unicornsoftwareinc commented Oct 1, 2021 • edited Loading

rubenheymans commented Jun 25, 2022 • edited Loading

iSeiryu commented Jul 7, 2022

aaronm67 commented Jul 19, 2022

karlhorky commented Jul 21, 2022 • edited Loading

aaronm67 commented Jul 21, 2022

karlhorky commented Jul 21, 2022 • edited Loading

Workaround

karlhorky commented Jul 31, 2023 • edited Loading

fweffort commented Nov 4, 2024 • edited Loading

We KNOW this is better for VIMEO and for us.

aaronm67 commented Nov 4, 2024

karlhorky commented Nov 8, 2024

karlhorky commented Dec 19, 2024 • edited Loading

karlhorky commented Dec 19, 2024

karlhorky commented Dec 19, 2024

aaronm67 commented Dec 19, 2024

pavanjadhaw commented Apr 12, 2020 •

edited

Loading

top-kat commented Nov 18, 2020 •

edited

Loading

unicornsoftwareinc commented Oct 1, 2021 •

edited

Loading

rubenheymans commented Jun 25, 2022 •

edited

Loading

karlhorky commented Jul 21, 2022 •

edited

Loading

karlhorky commented Jul 21, 2022 •

edited

Loading

karlhorky commented Jul 31, 2023 •

edited

Loading

fweffort commented Nov 4, 2024 •

edited

Loading

karlhorky commented Dec 19, 2024 •

edited

Loading