Skip to content
flinkeyflinkey for Developers

Assignment created result

POST
/webhooks/assignmentCreatedResult
curl --request POST \
  --url https://api-uat.flinkey.de/v3/webhooks/assignmentCreatedResult \
  --header 'Content-Type: application/json' \
  --data '{ "checksum": "abc123def456", "assignmentId": 77001, "carId": 12345, "userId": 54321, "start": "2026-01-31T10:00:00Z", "end": "", "customerId": 99001, "operationSucceeded": true, "errorMessage": null, "lifetime": null, "renewableAfter": null }'

Purpose

Receive the asynchronous result of an assignment creation request.

This webhook is sent by flinkey after an assignment creation operation has been processed.

Assignment creation is asynchronous.

The initial API response confirms that the create request was accepted.

This webhook provides the final operation result.

When to use this operation

Use this webhook when the partner backend needs to finalize local assignment state after creating an assignment.

Typical situations:

  • confirming that an assignment was created successfully,
  • storing the final assignmentId,
  • marking a local assignment as active,
  • marking a local assignment creation as failed,
  • storing errorMessage for troubleshooting,
  • enabling mobile access context after successful assignment creation,
  • reconciling pending assignment creation requests.

Do not mark an assignment as active before this webhook has been processed.

Do not provide mobile access context based only on the initial assignment creation API response if the partner flow requires confirmed assignment state.

Validation notes

PROD validation result:

  • The configured create-result endpoint received an HTTP POST after PUT /assignments returned 204 No Content.
  • The incoming request used Content-Type: application/json; charset=utf-8.
  • The successful payload contained numeric customer, assignment, car and user IDs.
  • checksum was present, operationSucceeded was true and errorMessage was null.
  • lifetime and renewableAfter were null in the validated payload.
  • The unrestricted assignment end was represented as an empty string in the webhook payload, while assignment read endpoints may return null.
  • No secret was configured for the create-result endpoint during this validation; secret transmission was validated separately with the assignment-updated webhook.

Async behavior

This webhook is the asynchronous result of Create assignment.

The partner backend should use this webhook to finalize local assignment state.

The initial assignment creation API response is not the final result.

Webhook result

Yes.

This entry describes the assignment created result webhook.

Use operationSucceeded to decide the final local state.

Security notes

Never log:

  • webhook secret,
  • full request headers,
  • backend bearer tokens,
  • API keys,
  • SDK Keys,
  • digital keys.

Validate the secret header if a webhook secret is configured.

Do not paste real webhook payloads containing sensitive identifiers into documentation, screenshots, tickets or AI prompts.

Use placeholders in documentation and examples.

The checksum is not a replacement for webhook secret validation.

Endpoint ownership

The receiving endpoint is configured and operated by the integration partner.

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
secret
string

Optional webhook secret configured in the flinkey Portal

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
checksum
required

Hash value generated from the payload of the initial request

string
assignmentId
required

Assignment database ID, or null if creation failed

number | null
carId
required

Car database ID the assignment is issued for

number
userId
required

User database ID the assignment is issued for

number
start
required

Assignment start time in date-time format

string
end
required

Assignment end time; an unrestricted assignment was returned as an empty string in the validated webhook

string
customerId
required

Customer database ID

number
operationSucceeded
required

Indicates whether assignment creation succeeded

boolean
errorMessage
required

Error message if the operation failed

string | null
lifetime

Assignment lifetime in seconds

number | null
renewableAfter

Renewal timing in seconds

number | null
Example
{
  "checksum": "abc123def456",
  "assignmentId": 77001,
  "carId": 12345,
  "userId": 54321,
  "start": "2026-01-31T10:00:00Z",
  "end": "",
  "customerId": 99001,
  "operationSucceeded": true,
  "errorMessage": null,
  "lifetime": null,
  "renewableAfter": null
}

Responses

Section titled “Responses”

200

Section titled “200”

Webhook event was accepted and processed successfully

204

Section titled “204”

Webhook event was accepted and processed successfully without response body

400

Section titled “400”

Webhook payload is invalid or cannot be parsed

Recommended handling: Reject the event and log sanitized diagnostics

401

Section titled “401”

Webhook secret is missing or invalid

Recommended handling: Reject the event and do not process the payload

403

Section titled “403”

Webhook secret is invalid or request is not allowed

Recommended handling: Reject the event and do not process the payload

500

Section titled “500”

Partner backend could not process the event

Recommended handling: Retry or escalate according to partner webhook handling policy