Skip to main content
POST
Create a trigger in a workspace

Authorizations

Authorization
string
header
required

API key: key id as the username, secret as the password. An account API key carries the same scopes as an OAuth token and is checked against the scopes listed under oauth2 on each operation. A trigger API key is limited to its trigger's workspace and reaches only the session operations that list this scheme alongside the oauth2 scopes.

Scopes

workspaces:write

Read and change workspaces

Path Parameters

workspace_id_or_name
string
required

Body

application/json
workspace_agent_id
string<uuid>
required

Installed agent ID

type
enum<string>
required
Available options:
webhook
webhook_config_id
string<uuid>
required

The integration's webhook_config.id, which guild_search_integrations returns

name
string | null

Trigger name

event_type
string | null

One of the webhook config's events, e.g. pull_request

action
string | null

One of that event's actions, e.g. opened; every action if unset

service_config
Service Config · object | null

Values for the webhook config's service_config_fields, e.g. {"repo": "owner/name"}

agent_input
Agent Input · object | null

Input for each run, which may include {webhook_payload}; when unset the agent receives the event payload

Response

The created trigger

The response is of type object.