Level up your Box knowledge with brand new learning paths on Box University. Visit training.box.com to get started

Box Status

Webhooks - Help

Follow
New post
Box Product Support

Hi,

 

I have added a webhook to my Box app integration (I followed the instructions from Box on how to do that), but am unsure how to actually instantiate it.

 

My application is for previewing so the simple flow is you select a file from Box and then my viewer will open it in a pop up. I want my webhook to alert me when a collaborator is added on a file. How does my application do that if it is strictly for previewing? Is there a better way to accomplish what I am trying to do?

 

On another note, what exactly do the callback parameters "to_user_ids" and "to_user_names" mean? From my understanding, it means if I share my document foo.bar with Joe, then the callback parameters will have Joe's username and Box id included? Please correct me if I am wrong.

 

Also, I noticed that it looks like you can only add collaborators on folders, not files. Will the webhook pick up on "sharing" of a file?

 

I hope this makes sense.

Thank you very much!

 

0

Comments

1 comment

Date Votes
  • AaronV

    Hello!

     

    Thank you for reaching out to us.Your last question about sharing may help inform the rest of your questions - I think this will help clarify sharing vs. adding collaborators. Sharingi s more of a distribution mechanism where collaboration is, well more about collaborating (editing, comments, etc.) https://community.box.com/t5/Collaboration-and-Sharing/What-Is-The-Difference-Between-Collaboration-And-Shared-Links/ta-p/146

     

    Collaborations today are mostly only available on Folders, withe the one file exception specifcally for Notes. In time we look to open up file-level collaboration. Given the narrow deployment of it, you read it right that we don't support an event for file level collaboration. Once file-level collaboration is more widely available, we will roll out that event trigger.

     

    On the flip side, the creation of shared links is not part of our "collaborator" permission model. As the creation of the shared link is (generally) a one-time thing and it can be reused. Depending in your use case, it may serve you better to set the webhook on the viewing of the file (FILE.PREVIEWED). 

     

    As for the callback parameters, are you referring to webhooks v1/non API based webhooks?

     

    Thanks!

    -av

    0
    Comment actions Permalink

Please sign in to leave a comment.