API Keys

Server

API key management

Webhook: API key created

POST

https://common-api.karma.life

/webhook/api_key.created

Fired when a new API key is created. The plaintext key is stripped from the payload for security. Note: as of writing, the publisher path has a TODO and may not yet be wired to Pub/Sub.

This is an outbound webhook event. Karma POSTs this payload to the URL you registered via POST /api/v1/webhooks/subscriptions. Your endpoint should respond 2xx within 30 seconds to acknowledge delivery.

Webhook: API key created › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

api_key.created

resource

string · enum · required

Enum values:

api_key

resourceId

string · required

String ID of the affected resource

timestamp

string · date-time · required

ISO 8601 timestamp when the event was emitted

apiVersion

string · enum · required

Enum values:

object

Webhook: API key created › Responses

200

Acknowledged. Karma considers any 2xx response a successful delivery; non-2xx triggers retry with exponential backoff.

No data returned

Webhook: API key updated

POST

https://common-api.karma.life

/webhook/api_key.updated

Note: as of writing, the publisher path has a TODO and may not yet be wired to Pub/Sub.

Webhook: API key updated › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

api_key.updated

resource

string · enum · required

Enum values:

api_key

resourceId

string · required

String ID of the affected resource

timestamp

string · date-time · required

ISO 8601 timestamp when the event was emitted

apiVersion

string · enum · required

Enum values:

object

Webhook: API key updated › Responses

200

Acknowledged. Karma considers any 2xx response a successful delivery; non-2xx triggers retry with exponential backoff.

No data returned

Webhook: API key revoked

POST

https://common-api.karma.life

/webhook/api_key.revoked

Note: as of writing, the publisher path has a TODO and may not yet be wired to Pub/Sub.

Webhook: API key revoked › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

api_key.revoked

resource

string · enum · required

Enum values:

api_key

resourceId

string · required

String ID of the affected resource

timestamp

string · date-time · required

ISO 8601 timestamp when the event was emitted

apiVersion

string · enum · required

Enum values:

object

Webhook: API key revoked › Responses

200

Acknowledged. Karma considers any 2xx response a successful delivery; non-2xx triggers retry with exponential backoff.

No data returned

Serving Centers Internal

Webhook: API key created

POST

https://common-api.karma.life

/webhook/api_key.created

Fired when a new API key is created. The plaintext key is stripped from the payload for security. Note: as of writing, the publisher path has a TODO and may not yet be wired to Pub/Sub.

Webhook: API key created › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

api_key.created

resource

string · enum · required

Enum values:

api_key

resourceId

string · required

String ID of the affected resource

timestamp

string · date-time · required

ISO 8601 timestamp when the event was emitted

apiVersion

string · enum · required

Enum values:

object

Webhook: API key created › Responses

200

Acknowledged. Karma considers any 2xx response a successful delivery; non-2xx triggers retry with exponential backoff.

No data returned

Webhook: API key updated

POST

https://common-api.karma.life

/webhook/api_key.updated

Note: as of writing, the publisher path has a TODO and may not yet be wired to Pub/Sub.

Webhook: API key updated › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

api_key.updated

resource

string · enum · required

Enum values:

api_key

resourceId

string · required

String ID of the affected resource

timestamp

string · date-time · required

ISO 8601 timestamp when the event was emitted

apiVersion

string · enum · required

Enum values:

object

Webhook: API key updated › Responses

200

Acknowledged. Karma considers any 2xx response a successful delivery; non-2xx triggers retry with exponential backoff.

No data returned

Webhook: API key revoked

POST

https://common-api.karma.life

/webhook/api_key.revoked

Note: as of writing, the publisher path has a TODO and may not yet be wired to Pub/Sub.

Webhook: API key revoked › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

api_key.revoked

resource

string · enum · required

Enum values:

api_key

resourceId

string · required

String ID of the affected resource

timestamp

string · date-time · required

ISO 8601 timestamp when the event was emitted

apiVersion

string · enum · required

Enum values:

object

Webhook: API key revoked › Responses

200

Acknowledged. Karma considers any 2xx response a successful delivery; non-2xx triggers retry with exponential backoff.

No data returned