Ambassador Settings
Learn about Ambassador Settings in WaymakerOS.
Configure how your ambassador runs — authentication, scheduling, source code, and lifecycle management.
General Settings
| Field | Description |
|---|---|
| Name | The display name of your ambassador |
| Description | A short description of what this ambassador does |
Repository Settings
| Field | Description |
|---|---|
| Repository URL | The GitHub repository containing your function code |
| Branch | The branch to deploy from (default: main) |
| Function Path | The entry file within the repo (default: index.ts) |
When a repository is connected, the settings page shows Pipeline active — pushes to the configured branch trigger automatic deployments.
Authentication Mode
Control who can call your ambassador:
| Mode | Behaviour | Use For |
|---|---|---|
| Auth Required | Every request must include a valid authentication token | Internal APIs, data processing, anything that accesses user data |
| Public | No authentication needed — anyone with the URL can call it | Public webhooks, status pages, health checks |
| API Key | Requests must include a valid API key | Third-party integrations, external service callbacks |
To change the authentication mode:
- Open Host and select your ambassador
- Go to the Settings tab
- Change the Auth Mode dropdown
- Click Save Changes
Schedule (Cron)
Run your ambassador automatically on a schedule. Enter a cron expression:
| Expression | Meaning |
|---|---|
* * * * * | Every minute |
0 * * * * | Every hour |
0 */6 * * * | Every 6 hours |
0 9 * * 1 | Every Monday at 9am UTC |
0 0 1 * * | First of every month at midnight UTC |
Leave the schedule field empty to disable automatic invocations. You can always invoke an ambassador manually.
Archiving an Ambassador
Archiving removes the serverless function from the network but keeps the record in Host. You can restore it later.
- Go to the Settings tab
- Scroll to Danger Zone
- Click Archive
- Confirm the action
Restoring an Ambassador
If you archived an ambassador and want to bring it back:
- Go to the Settings tab
- Click Restore
- Push to your repository to trigger a new deployment
The ambassador will be redeployed to the network on the next git push.
Next Steps
- Ambassadors — overview and getting started
- Creating an Ambassador — step-by-step creation guide
- Invoking & Logs — testing and monitoring
- Environment Variables — managing secrets