Skip to main content
Trigger API keys authenticate external systems that invoke Guild triggers over HTTP. Each key is scoped to a specific trigger. You can assign an optional name to each key to identify its purpose or origin.

​
Properties

PropertyTypeRequiredDescription
namestringNoA human-readable label for the key. Maximum 100 characters.

​
Create a trigger API key

Send a POST request to create a trigger API key. Include name in the request body to label the key. 
{
  "name": "ci-pipeline"
}
The name field is optional. Omit it to create an unnamed key. 
{}

​
Response

The API returns the created key. When name was provided at creation, it is included in the response. 
{
  "name": "ci-pipeline"
}
When name was not provided, the name field is absent from the response.