Idempotency

The Highnote GraphQL API supports idempotency to ensure platform reliability and consistency. Idempotency acts as a guardian, ensuring that API requests with identical parameters don’t trigger the same action twice if a connection error occurs.

Our Highnote API IdempotencyKey lets you reattempt failed API requests, without creating duplicates or provoking conflicts.

To enable idempotency, add an IdempotencyKey to all Highnote API mutations with the following specifications:

• Format: Version 4 UUID
• Length: 10 to 255 characters

After receiving the request, the Highnote platform stores the provided UUID with your Organization ID and query. With the idempotency key stored, the Highnote API tracks the parameters of incoming requests to determine if a request is new or a retry.

The following code snippet is an example of a mutation sent to the API with an idempotency key provided as an input variable: