Best practices on webhook registration, API - need more documentation

[KatharineSu]

We have been exploring registering a webhook under the documents section. Where else can we register a webhook? Is the documents section the only place? Looking for documentation or just confirmation on all possibilities. Thanks.

[RichardLe1]

Hi Katharine,

Are you referring to event subscriptions? So if / when a certain event happens on an object in Workfront, an outgoing webhook is fired to a pre-determined endpoint?

If yes, take a look at this article here on experience league. It details all of the different object types that support event subscriptions and takes you through the process of how to configure them.

Best Regards,

Rich. 

[KatharineSu]

Event subscriptions are an option but that means that we are "pulling" information vs having workfront push information real-time, no? I think that's where we were hoping we could use a webhook that's not registered in the documents location. 

[RichardLe1]

Hi Katharine,

With an event subscription, Workfront will deliver a data payload to an endpoint that you specify when an event occurs in real-time. In this scenario, Workfront is pushing information out in real time. The payload is fixed and sometimes will not contain everything that you require, so in some scenarios you may have to make a subsequent API call to pull the data you need.

Best Regards,

Rich.