@Marvin

actions=[
            prefect.events.actions.CallWebhook(
                block_document_id="XXXXX"
            )
        ]

How would I need to add a

CallWebhook

action when creating an automation via the Python SDK? The following results in all automations disappearing in the uI

It seems there was an issue retrieving the latest Prefect version. To assist you correctly, could you please confirm whether you are using Prefect 2.x or 3.x? Your answer will help me guide you with the right syntax and documentation links.

@Marvin I'm using Prefect 3.0.4. Could you provide me with an example of an automation created with the Python SDK which has a CallWebhook as action?

actions=[
            prefect.events.actions.CallWebhook(
                block_document_id="XXXXX"
            )
        ]

How would I need to add a

CallWebhook

action when creating an automation via the Python SDK? The following results in all automations disappearing in the uI I'm using Prefect 3.0.4. Could you provide me with an example of an automation created with the Python SDK which has a CallWebhook as action? Setting up a

CallWebhook

action within an automation using Prefect 3.0.4 via the Python SDK requires configuring your webhook correctly and using the associated API endpoints. Unfortunately, I couldn't find a specific example directly involving the Prefect SDK in Prefect 3.x documentation, but generally, the process involves: 1. Defining your webhook: This includes setting up the unique URL endpoint and a template to translate incoming requests into Prefect events. This can be done through the Prefect Cloud UI, CLI, or API. Here's a guide on how to set up webhooks: Prefect Webhooks Documentation. 2. Using the Prefect SDK to create automations: Right now, the documentation emphasizes using the Prefect Cloud for managing automations and webhooks. While there's no direct Python SDK example, you can interact with these features indirectly via API calls or Prefect CLI commands. Here’s a general approach based on my research: - Create and Configure a Webhook:

bash
  prefect cloud webhook create your-webhook-name \
  --description "Receives webhooks from your system" \
  --template '{ "event": "your.event.name", "resource": { "prefect.resource.id": "your.resource.id" } }'

- Set up Automation: To programmatically create an automation with a

CallWebhook

action, you'll typically use Prefect's automation API endpoints. Unfortunately, direct support using the Python SDK might not be fully documented yet. You might need to utilize HTTP requests against the Prefect's API or consult the Prefect Cloud UI for more straightforward setup. Since the automations are disappearing, double-check the webhook setup, ensure your Prefect Cloud setup is correctly authenticated, and ensure your actions and trigger events are defined appropriately. For more detailed, up-to-date instructions, and if issues persist, I recommend reaching out to the Prefect community or their support. They might offer specific Python SDK support or additional documentation updates for directly managing automations through the SDK. Creating an automation in Prefect 3.0.4 with a

CallWebhook

action via the Python SDK involves defining the webhook and setting the action for that webhook. Here’s a general approach based on the available documentation: 1. Define the Webhook: Webhooks are mainly handled through Prefect Cloud using the API, UI, or CLI. The webhook should have a unique URL endpoint to receive events and a template that translates incoming requests into Prefect events. 2. Define the Automation: An automation is created by defining trigger conditions and actions. In your case, the action involves calling the webhook. Here's a general example of creating a webhook and setting it as an action:

python
from prefect.events.actions import CallWebhook

# Define your webhook action
webhook_action = CallWebhook(
    block_document_id="XXXXX"  # Replace with your actual block document ID
)

# When defining an automation, include the webhook action
automation = {
    # Define trigger conditions, if necessary
    "actions": [webhook_action],
    # Optionally include more settings such as triggers
}

# Execute or manage the automation as required by your application setup

Useful Resources: - Webhooks in Prefect 3.0: Details on setting up and managing webhooks.

@Marvin When creating a custom notification block, this is stated in the docs: "All nested string param contains

{{key}}

will be substituted with value from context/secrets." However, I'm wondering what parameters are available to use?

In Prefect 3.0.4, when creating custom notification blocks, you can utilize placeholder parameters within your strings that are replaced with actual values from the context or secrets during runtime. Here's what you may need to know: ### Available Parameters for Substitution The user guide doesn't explicitly list all available parameters, but typically, these parameters are context variables or secrets you've defined. Here’s a general approach on how you might use these features: 1. Context Variables: These are dynamic values supplied by either the flow or task context. These might include: -

flow_run_id

-

task_run_id

-

current_time

-

state

-

name

of the task or flow 2. Secrets: If you've stored secrets in your Prefect account, you can access them by their key using: -

{{ secret_key }}

If you're using these placeholders in notification blocks, ensure that the keys you're using (like

{{key}}

) directly map to the expected value names in your context or secrets store. Example Use Case: Imagine you have a flow with several context variables and you want to use them in notifications:

python
{
  "message": "Flow {{name}} with ID {{flow_run_id}} is {{state}} at {{current_time}}."
}

### References: For more detailed information about using blocks and context, you can check the following guidance: - Prefect Blocks Documentation Unfortunately, there wasn't a distinct, detailed example in the documentation retrieved, but typically these placeholders work as described within the mentioned resources. If you have specific context keys within your task or flow, they would be usable directly in your string templates.