is there a good tutorial somewhere on building automation using webhooks? this guide on event-driven flows was a good start, but i specifically need more guidance on how to setup custom automation triggers with event-based filtering. the syntax isn't intuitive (to me at least), and the docs are a little thin. im staring at this json blob trying to figure out how i build in filters based on the event payload of the webhook .. its been a lot of trial-and-error to make any progress 🙃

{
  "match": {
    "prefect.resource.id": "prefect.flow-run.*"
  },
  "match_related": {
    "prefect.resource.id": "prefect.deployment.70cb25fe-e33d-4f96-b1bc-74aa4e50b761",
    "prefect.resource.role": "deployment"
  },
  "for_each": [
    "prefect.resource.id"
  ],
  "after": [],
  "expect": [
    "prefect.flow-run.Failed"
  ],
  "posture": "Reactive",
  "threshold": 2,
  "within": 10
}

Hi David. You might find this example helpful.

this is helpful, thanks @Jeff Hale .. i figured out that i need to take elements from the webhook payload and write them in as custom elements in the

resource

part of the webhook event. i can then use those elements as filters in the

match

part of the automation trigger setup. probably other ways to accomplish the same end result, but ive got this working for me as desired. 💪

@David Anderson Do you mind providing an example of how you used the custom elements in the

resource

part of the webhook event as a filter in the

match

part of the automation trigger? I am not sure how to do that. I've tried labeling the item as

resource.custom-element

but that is not working.

Hey @John Kang - I just made that might be helpful. You can click on an event that was created from the webhook and then click on Automate in the three dot menu in the top right. If you see something like

{
  "match": {
    "prefect.resource.id": "gh-repo-discdiver.41"
  },

You can use an asterisk to match on all the first part of the ids. e.g.

{
  "match": {
    "prefect.resource.id": "gh-repo-discdiver.*"
  },

Does that get you what you need?

@Jeff Hale Thanks so much for the reply! Not really.. I'm trying to use the body of the webhook call to respond differently. This one webhook is used to indicate when one of two different databases are updated. I want to use the body of the message to trigger different automations. I setup an automation using the contents of the element

prefect.resource.database

which I defined in the webhook:

{
  "match": {
    "prefect.resource.id": "webhook.resource.id"
  },
  "match_related": {
    "prefect.resource.name": "ovt_completion",
    "prefect.resource.database": "OVT PRODUCTION"
  },
  "after": [],
  "expect": [
    "webhook.called"
  ],
  "for_each": [],
  "posture": "Reactive",
  "threshold": 1,
  "within": 0
}

webhook results:

{
  "id": "868de4b3-f032-46fd-9c56-e5e051f6c984",
  "account": "f2264e8b-bee1-4943-89e5-2480677670cf",
  "event": "webhook.called",
  "occurred": "2023-12-15T17:04:15.057Z",
  "payload": {
    "method": "POST",
    "headers": {
      "host": "api.prefect.cloud",
      "user-agent": "python-requests/2.31.0",
      "accept-encoding": "gzip, deflate",
      "accept": "*/*",
      "content-length": "14",
      "x-request-id": "f5ebdd45-2095-94d2-a790-47fce49933db"
    },
    "body": "OVT PRODUCTION",
    "raw_body": "OVT PRODUCTION"
  },
  "received": "2023-12-15T17:04:15.059Z",
  "related": [
    {
      "prefect.resource.id": "prefect-cloud.webhook.1adf3e46-ff33-4405-b715-de0a8c1f5e24",
      "prefect.resource.name": "ovt_completion",
      "prefect.resource.role": "webhook"
    }
  ],
  "resource": {
    "prefect.resource.id": "webhook.resource.id",
    "producing": "OVT CADS",
    "prefect.resource.database": "OVT PRODUCTION"
  },
  "workspace": "140a070a-5c2c-4de9-9bf6-33d62e675a65"
}

Glad it’s working! As I understand it,

match_related

is for matching related Prefect events. I would expect that

expect

has the ability to be used to differentiate the two cases. Is something missing there? cc: @Will Raphaelson

@Jeff Hale Appreciate it! Makes sense. It would be nice to be able to be more prescriptive with `expect`because I'm not specifying from what field the expect is trying to match.

{
  "match": {
    "prefect.resource.id": "webhook.resource.id"
  },
  "match_related": {
    "prefect.resource.name": "ovt_completion"
  },
  "after": [],
  "expect": [
    "webhook.called",
    "ODIN PROD*"
  ],
  "for_each": [],
  "posture": "Reactive",
  "threshold": 1,
  "within": 0
}

Not that I know of, John, but Will might know better.

Thanks John, this is currently unsupported, but its on our radar for an enhancement to the triggers API. Your current direction is the closest one can get without using multiple automations or custom code.