Skip to main content

Create an Application

Create Applications

In this guide, we will create an application and generate an access token to authenticate API requests.

Overview​

Applications represent client applications that can authenticate and interact with the Hyperion API on behalf of a partner. Each application has a unique clientId and clientSecret that are used to generate access tokens for API authentication.

Hyperion API request and response fields use camelCase. Auth0 and other third-party OIDC/Okta integrations keep their vendor wire formats.

Getting Started​

Before creating an application, you need a partner account with the application:write permission.

  1. Log in to the Partners Portal
  2. Create an application with the application:write permission
  3. Use the Set Access Token button in the navbar to configure your partner access token

Once you have your partner access token configured, you can create applications using the Hyperion API.

Create an Application​

To create an application, send a POST request to the /applications endpoint with the application details.

We'll create an application with the scopes needed to complete the other guides:

Request body

Name of the application

application:read
application:write
event:data:read
event:read
event:write
key:read
key:write
member:read
member:write
monitorable:read
monitorable:write
monitorable-incident:read
monitorable:token:write
monitorable:data:read
webhook:read
webhook:write

List of scopes assigned to the application

cURL command

cURLPOST
curl -X POST "/v1/applications" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{
  "scopes": [
    "event:read",
    "event:write",
    "key:read",
    "key:write",
    "monitorable:read",
    "monitorable:write",
    "monitorable:token:write",
    "webhook:read",
    "webhook:write"
  ],
  "name": "Guides App"
}'

💡 Set your access token in the navbar to auto-fill the Authorization header

Response​

Upon successful creation, you'll receive a response containing the application details including the clientId and clientSecret:

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Guides App",
  "partnerId": "550e8400-e29b-41d4-a716-446655440001",
  "clientId": "client550e8400e29b41d4a716446655440002",
  "clientSecret": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
  "scopes": [
    "event:read",
    "event:write",
    "key:read",
    "key:write",
    "monitorable:read",
    "monitorable:write",
    "monitorable:token:write",
    "webhook:read",
    "webhook:write"
  ],
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}
Save the clientSecret immediately - it is only shown once and cannot be retrieved later.

Get an Access Token​

Now that you have your application credentials, use the clientId and clientSecret from the response above to generate an access token.

Send a POST request to the /applications/token endpoint with your credentials:

Request body

Application client ID

Application client secret

cURL command

cURLPOST
curl -X POST "/v1/applications/token" \
  -H "Content-Type: application/json"

Click the Set as access token button in the response to save the token for subsequent API requests. This token will be automatically included in the Authorization header for all requests made for the next few guides.

Response​

Upon successful authentication, you'll receive an access token:

{
  "accessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "tokenType": "Bearer",
  "expiresIn": 86400
}

Conclusion​

You've successfully created an application and generated an access token. The access token can now be used to authenticate API requests.

Next Steps​

Now that you have an authenticated application, you can start monitoring:

Learn More​

  • Members - Understanding scopes and permissions for your organization

API Reference​