Upcoming webhook improvements

Hello all! I have perhaps the most exciting news I’ve ever announced on this forum—the API team at Asana is now working on a number of webhook improvements! Ever since we launched the search API last year, webhooks has been the number one feature request/source of developer pain. (In fact, even before we launched the search API it was mostly a toss-up between the two.) After lots of investigation and design, we’re planning on three major improvements that will make Asana’s webhooks easier and more powerful.

A quick note: while we are actively working on these improvements and have an internal timeline, we don’t yet have a launch date for all these features. However, due to some technical constraints, you may observe these features (in a non-breaking way) before their official launch (such as new fields being included in webhook bodies). Now, to the good stuff!

  • Richer webhook events — We’re going to include more information in webhook events so that clients listening for webhooks can have a much better understanding of what actually changed in webhooks. Specifically, events will indicate what field on the object changed. No more fetching all the stories on the task to see what changed most recently—the webhook will tell you up-front. This also applies to events fetched in event streams.
  • Filters on webhook events — You’ll be able to define “filters” on your webhooks so that they only deliver the events you care about. No more dealing with a constant stream of noise when you only care about assignees and custom fields changing. Webhooks can have multiple filters to permit multiple kinds of events through a single subscription.
  • Webhooks with larger scopes (and new events) — Currently you can only create webhooks on tasks, projects, and tags. We’re going to expand that to include teams and workspaces so your app can learn about changes at higher levels. As a consequence of this, we’ll be introducing new events like “project created” and “user added to team.” Webhooks at larger scopes will be required to have certain filters on them, though, so you won’t be able to make high-volume subscriptions like “every change on every task in this organization.”

We hope you’re as excited about these changes as we are! We’ll be sharing more information in the coming weeks, but feel free to leave comments and questions here. Please also let us know what you think in this poll!

On a scale from 1 to 5, how excited are you about these improvements?

  • 1 - I strongly dislike these changes. This is bad for the API.
  • 2 - I dislike these changes. I think there are different improvements you should be making.
  • 3 - I’m indifferent to these changes.
  • 4 - I like these changes. They’ll have direct, positive impact on my app.
  • 5 - I love these changes! I can’t wait to start using them!

0 voters

5 Likes

I’m really looking forward for this feature. Do you have a ETA?

Looks like the new webhook changes are breaking our integration. We expected this format as used in the documentation:

{
“resource”: 1337,
“parent”: null,
“created_at”: “2013-08-21T18:20:37.972Z”,
“user”: 1123,
“action”: “changed”,
“type”: “task”
}

And, now we’re getting this:
[
{
“user”:
{“gid”:“123”,
“resource_type”:“user”
},
“created_at”:“2019-08-27T19:19:18.879Z”,
“action”:“changed”,
“parent”:null,
“resource”:
{“gid”:“247”,
“resource_type”:“project”
}

1 Like

Hi @Seth,

Actually what you’re seeing is completely unrelated to this upcoming change; what you’ve run into is this change to webhook structure:

That change was announced many months ago and has been slowly rolled out, but yesterday was made live for good; see:

You’re right, though; looks like the documentation still needs to be updated. (@Joe_Trollo…)

2 Likes

Thanks Phil. Normally, my source of truth is the documentation - and it’s unfortunately wrong.

1 Like

I have a PR open for this right now - it’s in my hands, @Phil_Seeman and @Seth.

@Phil_Seeman is right, this webhook change is for string IDs and not for the improvements @Joe_Trollo is mentioning above. Sorry for the delay on this, with our internal Roadmap Week it got put on the back burner :confused: but it’s high-priority for me at the moment. Expect updates soon!

1 Like