Question

Can't figure out Webhook Filter format or what values are available to filter on

  • 15 December 2023
  • 2 replies
  • 30 views

I’m trying to set up a webhook to fire from Guru every time a card with tagId=1234 is updated. I can’t quite figure out the format for the “filter” property in the body of my JSON payload.
I see the simple example here, but I can’t find a list of what event types are available to provide as parameters.

The payload I’m working with is:

{
"deliveryMode":"SINGLE",
"targetUrl":"https://myURL.com",
"status":"ENABLED",
"filter":"card-updated, tag-1234-567-890 exists"
}

which of course is not working. It returns:
 

{
"description" : "Webhook filter contains unknown events"
}

Any help here would be appreciated. Thanks!


2 replies

Userlevel 3
Badge

Hi @Corey Loftus!

We only allow webhook filters that are listed on this page. Filtering where tagId = 1234 is not possible at the webhook creation step of your process. Once you receive a webhook event for card-created, you’ll then need to call the /api/v1/cards/{cardId}/extended endpoint using the cardId given to you in the webhook response to see whether tagId 1234 exists on the card.

Here is what this would look like laid out in steps:

  1. Create your webhook using this payload:
{
"deliveryMode":"SINGLE",
"targetUrl":"https://myURL.com",
"status":"ENABLED",
"filter":"card-updated"
}
  1. Call the /api/v1/cards/{cardId}/extended endpoint using the cardId you received in the webhook event to see if your tagId exists on the card

  2. Perform whatever action you’d like if your tagId exists on the card

Hope this is helpful - let me know if you have any additional questions!

Joe

Superb! Thanks. This approach works just fine. I appreciate your quick response here.

I had a look around the API Docs and couldn’t find this single Card show route you just shared. Did I miss seeing it somewhere?

Thanks again!

Reply