Skip to content

Partner Onboarding

This guide walks you through the onboarding process for integrating with ChronosHub. Depending on your use case, you can be onboarded for the inbound flow (sending events to ChronosHub), the outbound flow (receiving events from ChronosHub), or both.

Note: Onboarding is currently a manual process managed by the ChronosHub team. All credentials and configuration are handled on our side upon contract agreement.


Onboarding for Inbound Events

If your integration requires sending events to ChronosHub, you will be onboarded for the inbound flow.

What ChronosHub Provides

  1. API Key — ChronosHub generates a unique API key for your organization. You will receive it through a secure, one-time-view link. Once you view the key, it cannot be retrieved again — store it securely.

  2. Event types — ChronosHub will confirm which event types you are authorized to send and share the expected payload schemas for each.

  3. Environment access — You will be given the base URLs for the environments you have access to (typically test first, then production).

What You Need to Do

  1. Store your API key securely. Treat it like a password. Do not hard-code it in source code or share it in plain text.

  2. Implement the API call. Send events to ChronosHub as described in Inbound Events. Every request must include your API key in the X-Api-Key header.

  3. Test in the test environment. Use the test environment to validate your integration before going live. You can also use the interactive API reference to explore and test the endpoints.


Onboarding for Outbound Events

If your integration requires receiving events from ChronosHub, you will be onboarded for the outbound flow.

What ChronosHub Provides

  1. Webhook secret — ChronosHub generates a shared secret for signing webhook payloads. You will receive it through a secure, one-time-view link. Once you view the secret, it cannot be retrieved again — store it securely.

  2. Event subscriptions — ChronosHub configures which event types are delivered to your webhook, based on what you need.

What You Need to Provide

  1. Webhook URL — An HTTPS endpoint on your side where ChronosHub will deliver events via POST requests. This must be reachable from ChronosHub's infrastructure.

What You Need to Do

  1. Store your webhook secret securely. You will need it to verify the signature on every incoming webhook request.

  2. Implement your webhook endpoint. Your endpoint should:

    • Accept POST requests with a JSON body.
    • Verify the request signature using your webhook secret.
    • Return a 2xx status code to acknowledge receipt.
  3. Test in the test environment. Verify that you can receive and process events correctly before going live.

See Outbound Events for the full webhook request format, headers, and signature verification instructions.


Using Both Flows

If your use case requires both sending and receiving events, ChronosHub will onboard you for both flows. You will receive:

  • An API key for sending inbound events.
  • A webhook secret for verifying outbound events delivered to your webhook.

Both credentials are issued through secure one-time-view links.


Credential Management

CredentialPurposeHow You Receive It
API KeyAuthenticate inbound event requests (X-Api-Key header)Secure one-time-view link
Webhook SecretVerify signatures on outbound webhook deliveriesSecure one-time-view link

Important:

  • Credentials are shown only once. If you lose them, contact ChronosHub to have them rotated.
  • If you suspect a credential has been compromised, notify ChronosHub immediately so we can rotate it.

Support

For onboarding requests, credential issues, or integration questions, reach out to your ChronosHub onboarding contact.