WebHooks implementation

[ysavourel]

The webhook defined are not linked to a specific job or task or asset. So how do we know which one to call when for example a taskUpdated event occurs?

Let's say a client creates 2 jobs, with each 2 assets which have 1 tasks. that gives us 4 tasks:

• /jobs/1/assets/11/tasks/111
• /jobs/1/assets/12/tasks/121
• /jobs/2/assets/21/tasks/211
• /jobs/2/assets/22/tasks/221

Let's say we create one webhook for that client:

• /webhook/1 (eventType=taskUpdated)

Let say task 211 is updated: The TAPICC server would go through the list of all webhooks for that client, find the ones for taskUpdated and fire them. Most likely there will be only one webhook for taskUpdated per client (but it's not specified anywhere).

For the client to be able to do anything meaningful either:

• the payload of the request is defined by TAPICC and includes the information about the event triggered (like the task object)
• or the URL of the webhook include one or more variables that is filled by TAPICC with the corresponding values for that event. Something like: https://myclient.com/tappic/callbacks/taskupdated?jobId={jobId}&taskId={taskId} which the server would send as https://myclient.com/tappic/callbacks/taskupdated?jobId=2&taskId=211
• or both: the task object is send as payload and the URL has variables (this may allow the client to avoid doing a call to the server). Most likely the client need more information since the taskUpdated is a rather generic event.

Also we would need to decide what kind of call is to be send: a POST, PUT or GET. Or have that information in the webhook properties.

Another question: Are the event types too generic? Would it make sense to have only types of event corresponding to changes meaningful for the client? (e.g. when a task is paused, the client may not care about it: the lone task event that most clients will be watching for is when the task is done or fails)

[Alino]

Webhooks are currently not implemented in this TAPICC implementation.

In general, webhooks usually are making a POST request to the webhook URL. So I would expect that create, update, delete actions on any collection should POST the whole object in the request body to the webhook URL.

The update action could also send a diff of the changes between the old object, and the updated one.

Would it make sense to have only types of event corresponding to changes meaningful for the client? (e.g. when a task is paused, the client may not care about it: the lone task event that most clients will be watching for is when the task is done or fails)

I think the webhooks should not care about what data has been updated, and it should just trigger on the specific event without complicated conditions (at least for now, but can be implemented later when needed). The checks what was updated could be handled on the client side who is receiving the webhook data.

[terales]

It seems that we don't need webhooks: we just need to pass TAPICC API URL and systems will be able to communicate by a predefined set of requests:

What do you think?

[Alino]

I think it makes sense, I have removed webhooks for now from swagger. Closing this.

[Alino]

I just had a call with Jim, and I realised there could be third system which would for example want to know about when a Job was created. That would be a good use case for webhooks, so I am reopening this and putting back webhooks to swagger.