Skip to main content
POST
Execute a workflow for a SendGrid inbound email

Path Parameters

id
string
required

Body

application/json

Internal service payload forwarded by an inbound-email adapter (e.g. services/sendgrid-inbound). The workflow is run against the supplied email under the specified organization.

organizationId
string
required

Owning organization for the run — must match the workflow's organizationId.

emailData
object
required

Parsed inbound email payload. Either supply the flat fields (from/to/subject/…) or a nested email object — from, to, and subject are required.

userId
string

Optional User _id to attribute the run to. Falls back to the workflow's creator when omitted.

Response

Workflow executed successfully

Returned by POST /api/workflows/{id}/execute/sendgrid-inbound after the internal service hands off the email payload to the workflow engine.

success
enum<boolean>
required
Available options:
true
message
string
required