v4

latestOpenAPI 3.1.02026-07-3163216290.7 KB

Event patterns

Get an event pattern by name

Retrieve event pattern details by event name for a workflow event trigger. Event names are case-sensitive, so PaymentReceived and paymentReceived are different events.

get/v1/event-patterns/by-name/{eventName}

Response

Successful.

idstring required

eventNamestring required

The name of the event pattern. Use this when sending events with the API.

incomingWebhookPlatform'clerk' | 'polar' | 'stripe' | 'supabase' | 'null' nullable required

The platform that sent this event pattern, if the event pattern is from an incoming webhook. Will be null for custom events.