Completing your application

This section explains what technical information your team should have ready while completing the application.

OAuth 2.0 configuration

This defines the connection contract Terra uses to authenticate users and exchange tokens.

Your OAuth setup should make the authorization code flow deterministic:

  • authorization endpoint behavior is stable

  • token exchange is reliable

  • refresh/revoke behavior is clear (if supported)

User ID extraction

This tells Terra how to resolve your canonical user identifier after authorization.

Choose one strategy:

  • extract from token response, or

  • call a user-info endpoint and parse from response.

Scopes

This defines the permission model Terra uses for your integration:

  • how scopes are requested,

  • where granted scopes are returned,

  • and which scopes are required for each endpoint.

Data endpoints

For each endpoint, provide enough detail for predictable data retrieval:

  • endpoint purpose and response shape

  • access method and auth expectations

  • scope requirements

Integration methods (inside application flow)

Terra supports both methods:

  1. Polling

    Terra fetches data from your API endpoints.

  2. Webhooks

    Your platform sends events to a Terra webhook destination.

You can support one method or both.

If your API uses a different integration/auth pattern, contact [email protected]envelope.

Testing your integration

Testing validates that your submitted configuration can authenticate and retrieve data correctly.

What is tested:

  • OAuth flow + token exchange

  • user ID and scope extraction behavior

  • endpoint retrieval using provided configuration

Data availability guidance: your test account should contain recent, retrievable records for the data types you declare.

Last updated

Was this helpful?