Provider Service¶

The Provider Service enables the creation and management of ecosystems and webhooks.

Named vs Anonymous ecosystems

There are two types of ecosystems: named and anonymous.

Named ecosystems are suitable for production, and will be prepared for you by Trinsic during onboarding.

Anonymous ecosystems have auto-generated names (such as eager-elephant-94jkn5h), and may be created by anyone at any time.

Using an anonymous ecosystem for purposes other than prototyping and testing is considered an unauthorized use of Trinsic's platform.

Create Ecosystem¶

Creates a new ecosystem, along with a root controlling account.

If name is left empty, an anonymous ecosystem will be created.

Sample Request Response

Trinsic CLITypeScriptC#PythonGoJava

trinsic provider create-ecosystem --name <ECOSYSTEM_NAME> --email <OWNER_EMAIL>

let createResponse = await trinsic.provider().createEcosystem(
  CreateEcosystemRequest.fromPartial({
    description: "Test ecosystem from Node",
    uri: "https://example.com",
  })
);

var (ecosystem, authToken) = await trinsic.Provider.CreateEcosystemAsync(new() {
    Description = "My ecosystem",
    Uri = "https://example.com"
});

actual_create = await trinsic_service.provider.create_ecosystem(
    request=CreateEcosystemRequest(
        description="My ecosystem", uri="https://example.com"
    )
)

actualCreate, err := trinsic.Provider().CreateEcosystem(context.Background(), &provider.CreateEcosystemRequest{
    Description: "My ecosystem",
    Uri:         "https://example.com",
})

var response =
    trinsic
        .provider()
        .createEcosystem(
            CreateEcosystemRequest.newBuilder()
                .setDescription("My ecosystem")
                .setUri("https://example.com")
                .build())
        .get();

CreateEcosystemRequest

Request to create an ecosystem

name

optional string

Globally unique name for the Ecosystem. This name will be part of the ecosystem-specific URLs and namespaces. Allowed characters are lowercase letters, numbers, underscore and hyphen. If not passed, ecosystem name will be auto-generated.

description

optional string

Ecosystem description

uri

optional string

External URL associated with your organization or ecosystem entity

details

AccountDetails

The account details of the owner of the ecosystem

Show child attributes

CreateEcosystemResponse

Response to CreateEcosystemRequest

ecosystem

Ecosystem

Details of the created ecosystem

Show child attributes

profile

AccountProfile

Account profile for auth of the owner of the ecosystem

Show child attributes

confirmation_method

ConfirmationMethod

Indicates if confirmation of account is required.

Show enum values

Update Ecosystem¶

Updates the active ecosystem's description or uri.

Sample Request Response

Trinsic CLITypeScriptC#PythonGoJava

trinsic provider update-ecosystem \
                 --description "New description" \
                 --uri "https://new-example.com"

let updateResponse = await trinsic.provider().updateEcosystem(
  UpdateEcosystemRequest.fromPartial({
    description: "New ecosystem description",
    uri: "https://new-example.com",
  })
);

var updateResult = await trinsic.Provider.UpdateEcosystemAsync(new() {
    Description = "New ecosystem description",
    Uri = "New ecosystem URI"
});

request = UpdateEcosystemRequest(
    description="My new description", uri="https://example.com"
)
response = await trinsic.provider.update_ecosystem(request=request)

updateRequest := &provider.UpdateEcosystemRequest{
    Description: "My new description",
    Uri:         "https://new-example.com",
}

updateResponse, err := trinsic.Provider().UpdateEcosystem(context.Background(), updateRequest)

var updateResponse =
    trinsic
        .provider()
        .updateEcosystem(
            UpdateEcosystemRequest.newBuilder()
                .setDescription("My updated ecosystem")
                .setUri("https://new-example.com")
                .build())
        .get();

UpdateEcosystemRequest

Request to update an ecosystem's metadata

description

string

New description of the ecosystem

uri

string

New external URL associated with the organization or ecosystem entity

UpdateEcosystemResponse

Response to UpdateEcosystemRequest

Ecosystem

Current ecosystem metadata, post-update

Show child attributes

Get Ecosystem Info¶

Fetches information about the active ecosystem.

Sample Request Response

Trinsic CLITypeScriptC#PythonGoJava

trinsic provider ecosystem-info

const infoResponse = await trinsic
  .provider()
  .ecosystemInfo(EcosystemInfoRequest.fromPartial({}));

const ecosystem = infoResponse.ecosystem;

var infoResult = await trinsic.Provider.EcosystemInfoAsync(new());

response = await trinsic.provider.ecosystem_info(request=EcosystemInfoRequest())
ecosystem = response.ecosystem

infoResponse, err := trinsic.Provider().EcosystemInfo(context.Background(), &provider.EcosystemInfoRequest{})

var infoResponse =
    trinsic.provider().ecosystemInfo(EcosystemInfoRequest.getDefaultInstance()).get();

EcosystemInfoRequest

Request to fetch information about an ecosystem

This message has no fields

EcosystemInfoResponse

Response to InfoRequest

ecosystem

Ecosystem

Ecosystem corresponding to requested ecosystem_id

Show child attributes

Add Webhook¶

Adds a webhook to an ecosystem.

Sample Request Response

Trinsic CLITypeScriptC#PythonGoJava

trinsic provider add-webhook \
                --url "https://example.com/webhooks/trinsic" \
                --secret "my well-kept secret" \
                --events "*"

let addResponse = await trinsic.provider().addWebhook(
  AddWebhookRequest.fromPartial({
    destinationUrl: "https://example.com/webhooks/trinsic",
    secret: "my well-kept secret",
    events: ["*"],
  })
);

var addWebhookResponse = await trinsic.Provider.AddWebhookAsync(new() {
    DestinationUrl = "https://example.com/webhooks/trinsic",
    Secret = "my well-kept secret"
});

request = AddWebhookRequest(
    destination_url="https://example.com/webhooks/trinsic",
    secret="my well-kept secret",
)
request.events.append("*")  # Enable all events

response = await trinsic.provider.add_webhook(request=request)

request := &provider.AddWebhookRequest{
    DestinationUrl: "https://example.com/webhooks/trinsic",
    Secret:         "my well-kept secret",
    Events:         []string{"*"}, // All events
}

response, err := trinsic.Provider().AddWebhook(context.Background(), request)

var addWebhookResponse =
    trinsic
        .provider()
        .addWebhook(
            AddWebhookRequest.newBuilder()
                .setDestinationUrl("https://example.com/webhooks/trinsic")
                .setSecret("my well-kept secret")
                .addEvents("*") // All events
                .build())
        .get();

AddWebhookRequest

Request to add a webhook to an ecosystem

destination_url

string

Destination to post webhook calls to. Must be a reachable HTTPS URL.

secret

string

Secret string used for HMAC-SHA256 signing of webhook payloads to verify that a webhook comes from Trinsic

events

string[]

Events to subscribe to. Default is "*" (all events)

AddWebhookResponse

Response to AddWebhookRequest

ecosystem

Ecosystem

Ecosystem data with new webhook

Show child attributes

Webhook Limits

At present, an ecosystem can have no more than 10 webhooks.

Wallet Webhook Events

In order to receive webhooks for events which occur on a wallet, an additional authorization step must be performed.

See AuthorizeWebhook for more info.

Delete Webhook¶

Deletes a webhook from an ecosystem.

Sample Request Response

Trinsic CLITypeScriptC#PythonGoJava

trinsic provider delete-webhook --webhook-id <WEBHOOK_ID>

let deleteResponse = await trinsic.provider().deleteWebhook(
  DeleteWebhookRequest.fromPartial({
    webhookId: webhookId,
  })
);

var deleteWebhookResponse = await trinsic.Provider.DeleteWebhookAsync(new() {
    WebhookId = webhookId
});

response = await trinsic.provider.delete_webhook(
    request=DeleteWebhookRequest(webhook_id)
)

request := &provider.DeleteWebhookRequest{
    WebhookId: webhookId,
}

deleteResponse, err := trinsic.Provider().DeleteWebhook(context.Background(), request)

var deleteWebhookResponse =
    trinsic
        .provider()
        .deleteWebhook(DeleteWebhookRequest.newBuilder().setWebhookId(webhookId).build())
        .get();

DeleteWebhookRequest

Request to delete a webhook from an ecosystem

webhook_id

string

ID of webhook to delete

DeleteWebhookResponse

Response to DeleteWebhookRequest

ecosystem

Ecosystem

Ecosystem data after removal of webhook

Show child attributes