COcognigy
Endpoints

Create an Endpoint API Key

Generates a new API key for the given Webhook/Generic Endpoint. Returns the plaintext key in the response body exactly once — the server stores only the SHA-256 hash and a masked preview, and the plaintext is never retrievable again.

post/v2.0/endpoints/{endpointId}/apikeys

Request

Path parameters

endpointIdstring required

The Id of the Endpoint

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Request body

namestring required

Customer-provided display name for the key.

Example request

{
  "name": "My CRM webhook"
}

Response

The Endpoint API Key was created. The plaintext key is returned exactly once.

_idstring
namestring

Customer-provided display name for the key.

keyPreviewstring

Masked preview of the plaintext key (first 4 chars + masked middle + last 4 chars). Captured at generation time.

createdAtinteger

Unix-timestamp

keystring required

The plaintext API key. Returned exactly once. The caller must persist it client-side — the server will not show it again.

Example response

{
  "name": "My CRM webhook",
  "keyPreview": "8a4f••••••••7c2e",
  "createdAt": 1694518620,
  "key": "8a4fcd9b2e5f17b03f9c4a6d7c2e5f17b03f9c4a6d7c2e5f17b03f9c4a6d7c2e"
}

Changes

No recorded changes to this operation across all 1 revision of this API.