Run webhook

runWebhook(input: RunWebhookInput!): WebhookRunResult!

Arguments

ArgumentTypeRequired
inputRunWebhookInput!Yes

Input fields

input

RunWebhookInput

FieldTypeRequiredDescription
projectReferenceStringNo
idID!YesWebhook definition ID. Task and workflow targets accept a project-execution credential that carries native source authority from project.runs.write instead of project.agents.write. Agent targets require project.agents.write, plus project.conversations.write for conversation-backed targets.
payloadJSONNo

Response

Returns WebhookRunResult!. Open the type for its fields and nested types.

FieldTypeDescription
idID!The webhook event id. Pass it as webhookEventId to replayWebhookEvent.
webhookIdID!The id of the webhook that received the event.
projectIdID!
conversationIdID
messageIdID
runIdString
canonicalRunIdID
latestEventIdInt

All fields of WebhookRunResult.

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
mutation RunWebhook($input: RunWebhookInput!) {
  runWebhook(input: $input) {
    id
    projectId
    runId
    status
    canonicalRunId
  }
}
json
{
  "input": {
    "id": "00000000-0000-4000-8000-000000000001",
    "projectReference": "example-project"
  }
}