Brandwave/Docs

Personal access tokens#

Create and manage personal access tokens for API authentication.

Provider required

All hooks require a BrandwaveProvider ancestor in your component tree. See the React Hooks overview for setup instructions.

useCreatePersonalAccessToken#

Create a new personal access token. The plaintext token is only returned once.

typescript
import { useCreatePersonalAccessToken } from '@brandwave/react';

const { mutate, isPending } = useCreatePersonalAccessToken();

mutate({
  name: 'My Campaign',
});

Parameters#

NameTypeRequiredDescription
namestringRequiredDisplay name for this token.
expiresAtstring (ISO 8601) | null—When this token should expire.

Response#

Returns { data } with the result.

Underlying SDK method: bw.personalAccessTokens.create(params)

Store the token securely

The plaintext token is only returned in the creation response. It cannot be retrieved again. Store it securely.

useListPersonalAccessTokens#

List all personal access tokens for the authenticated user.

typescript
import { useListPersonalAccessTokens } from '@brandwave/react';

const { data, isLoading } = useListPersonalAccessTokens({

});

Response#

Returns { items, totalCount, facets } with paginated results.

Underlying SDK method: bw.personalAccessTokens.list()

useRevokePersonalAccessToken#

Revoke a personal access token, immediately invalidating it.

typescript
import { useRevokePersonalAccessToken } from '@brandwave/react';

const { mutate, isPending } = useRevokePersonalAccessToken();

mutate({
  id: 'abc-123',
});

Parameters#

NameTypeRequiredDescription
idstring (UUID)RequiredToken identifier to revoke.

Response#

Returns { data } with the result.

Underlying SDK method: bw.personalAccessTokens.revoke(params)

Immediate invalidation

Revoking a token immediately invalidates it. Any integrations using this token will stop working. This action cannot be undone.

useRotatePersonalAccessToken#

Rotate a personal access token by revoking the old one and creating a new one.

typescript
import { useRotatePersonalAccessToken } from '@brandwave/react';

const { mutate, isPending } = useRotatePersonalAccessToken();

mutate({
  id: 'abc-123',
});

Parameters#

NameTypeRequiredDescription
idstring (UUID)RequiredToken identifier to rotate (revokes old, creates new).

Response#

Returns { data } with the result.

Underlying SDK method: bw.personalAccessTokens.rotate(params)