API tokens and webhooks
Create, rename and revoke API tokens on the Developers page, and see the state of webhooks.
The Developers page is where you create API tokens for your workspace. A token lets an outside tool connect to the workspace: the Tarkle WordPress plugin connects with one, and so does the Brand API. This article covers creating, copying, renaming and revoking a token, and what the Webhooks tab offers today.
Open the Developers page
Open the Developers page in the Tarkle app. The page has two tabs, API Tokens and Webhooks, and it opens on API Tokens. Each token belongs to one workspace, and the list shows the tokens of that workspace only.
Create a token
Click New token on the API Tokens tab.
In Token name, type a name you will recognise, such as "Production API".
Under Public API access, tick the scopes the token needs.
Click Create.
A scope sets what the token may do in the Brand API. Each scope is listed with its description:
brands:read: Read brands, their assets, brand.md and analytics.
brands:write: Update a brand's text, links, access and settings.
brands:requests: List download and view requests and approve or reject them.
A token with no access selected cannot call the Brand API. The WordPress plugin does not need any scope. The calls each scope allows are listed in Brand API endpoints.
Copy the token
After you click Create, the Token created dialog shows the full token under Token (shown once). Click the token to copy it, then click Done. The dialog says: "This token will not be shown again. Save it in a secure location."
Tarkle keeps a hash of the token and its first characters, not the full token. Once you close the dialog, the full token cannot be shown again. If you lose it, revoke the token and create a new one.
Manage your tokens
The list has four columns: Name, Token, Last used and Created. The Token column shows the first characters of the token followed by dots. Last used shows Never for a token that has not been used. To find a token, type its name in the Search tokens... box above the list.
Each row has a three-dot menu at its right end:
Rename opens Rename token. Change the name and click Save.
Revoke opens Revoke token and asks you to confirm. Click Revoke to confirm.
A revoked token leaves the list and stops working: the Brand API and the WordPress plugin no longer accept it. To keep a connection working, create a new token and put it in the tool in place of the revoked one.
Webhooks
The Webhooks tab shows a table and a Create webhook button. The button is disabled, so webhooks cannot be set up yet. To connect a tool today, create an API token as described above.
What happens next
Copy the token into the tool you are connecting. For the WordPress plugin, follow WordPress integration. For the Brand API, the Brand API quick start creates a token with the right scopes and makes the first calls.