A Outpost project represents a managed deployment of Outpost. You can create multiple projects within an organization to separate different environments, use cases, or teams. Each project is a self-contained deployment of Outpost with its own API key, configuration, tenants, destinations and access control.

Create a project

Creating a project gives you a blank canvas for new connections. Each project is completely distinct from the next.

Organization administrators can create both public and private projects. Organization members can only create private projects for which they will be the only member until an organization administrator adds more members or makes the project public.

1. Click your current organization on the left of the dashboard.
2. Click Create Project at the bottom of the dropdown.
3. Give your new project a name and choose the "Outpost" project type and click Create Project.
4. You will be taken to your new project. To return to a previous project, click the current organization name in the top left of the dashboard and select the desired project in the dropdown.

General settings

The General tab in your project settings allows you to define key configuration such as your topics and retry schedule.

Custom domain

You can set a custom domain for your project, which will be used within your generated Source HTTP URLs. This is useful if you want to customize the URLs you share with your customers or embed them into your clients that generate events.

Delivery with static IPs

To enable delivery Static IPs in a Outpost project, contact us.

Transfer a project

Projects can be transferred from one organization to another. In order to transfer a project, you must be an admin of both the current and destination organizations.

A transfer will not affect the project's configuration, connections, or event history. The transfer happens immediately, but any existing private project members will lose access. You will need to re-add them to the project in the new organization if they have access to that organization.

1. Visit the General tab in your project settings.
2. Scroll to the "Transfer Project" section of the general settings.
3. Click the Transfer button.
4. Select the destination organization from the dropdown.
5. Click Transfer project.

Delete a project

Projects can be deleted. Deleting a project is irreversible and will delete all the project's configuration, connections, and event history.

Any usage charges incurred by the project will be billed to the organization's billing account.

1. Visit the General tab in your project settings.
2. Scroll to the "Delete Project" section of the general settings.
3. Click the Delete button.
4. Type in the name of your project as confirmation
5. Click Delete project.
6. You will lose access to the project right away; you can select or create a new one and get back to the dashboard.

Destinations

Outpost webhooks and destinations specific configurations like HTTP headers, signatures, user agents can be configured in the Destinations tab in your project settings.

Monitoring

Outpost Operator Events configuration and Opentelemetry metrics are available in the Monitoring tab in your project settings.

User Portal

The User Portal tab in your project settings allows you to enable and configure your project's user portal.

In order to enable the user portal, you'll need to set a custom domain for your project which requires you to update your DNS records.

Once the DNS records are validated and the SSL certificate is provisioned, you can access the user portal at your custom domain.

Publishing

You can configure a message broker to publish your events to Outpost in the Publishing tab in your project settings.

API Key

The API Key tab in your project settings is where you can manage your project's API key.

API Key

Your API key serves as the Bearer token to authenticate with Outpost API.

Rolling your credentials

To roll your secret, click the more ... button next to the secret then Roll Key.

When rolling the secret, you can select an expiration allowing for no downtime rotation. The secret will expire after the selected time. Both the old and the new secret will be valid during the transition period.

Access control

The Access Control tab in your project settings displays all the users who have access to your project's connections, event history, issues, and more. Project and organization admins can toggle the project between public and private.

Public vs Private projects

Projects can be public or private, as indicated by the lock icon next to the project name. Public projects are visible to all organization members.

Private projects are only visible to members who have been granted access. Organization admins always have access to all projects within the organization and are shown as "Inherited" members on private projects.

On private projects, organization members need to be explicitly added to the project to access it.

Project membership, private project access, and project member roles are documented in Members and Access Control.