Skip to content
flinkeyflinkey for Developers

Assignment updated result

POST
/webhooks/assignmentUpdatedResult
curl --request POST \
  --url https://api-uat.flinkey.de/v3/webhooks/assignmentUpdatedResult \
  --header 'Content-Type: application/json' \
  --data '{ "checksum": "abc123def456", "assignmentId": 77001, "customerId": 99001, "operationSucceeded": true, "errorMessage": null, "updateData": [ { "op": "replace", "path": "/end", "value": "2026-01-31T20:00:00Z" } ] }'

Purpose

Receive the asynchronous result of an assignment update request.

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

Assignment update is asynchronous.

The initial API response confirms that the update 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 updating an assignment.

Typical situations:

  • confirming that an assignment update was processed successfully,
  • marking a local assignment update as successful,
  • marking a local assignment update as failed,
  • applying updated assignment start or end times locally,
  • storing errorMessage for troubleshooting,
  • reconciling pending assignment update requests,
  • deciding whether mobile access context can continue to be used.

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

Do not rely only on the initial assignment update API response for final assignment state.

Validation notes

PROD validation result:

  • The configured update-result endpoint received an HTTP POST after the assignment update API returned 204 No Content.
  • The incoming request used Content-Type: application/json; charset=utf-8.
  • The configured webhook secret was transmitted in the secret request header.
  • The successful payload contained checksum, numeric assignmentId, numeric customerId, operationSucceeded: true, errorMessage: null and the requested JSON Patch operation in updateData.
  • The webhook secret must be treated as sensitive and replaced if exposed during testing.

Async behavior

This webhook is the asynchronous result of Update assignment.

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

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

Webhook result

Yes.

This entry describes the assignment updated result webhook.

Use operationSucceeded to decide the final local update 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

number
customerId
required

Customer database ID

number
operationSucceeded
required

Indicates whether assignment update succeeded

boolean
errorMessage
required

Error message if the operation failed

string | null
updateData
required

List of assignment update operations

Array<object>
object
updateData.op
required

Update operation. Allowed values are remove and replace

string
updateData.path
required

Assignment field that was updated

string
updateData.value
required

New value for the selected path, or null where applicable

string | null
Example
{
  "checksum": "abc123def456",
  "assignmentId": 77001,
  "customerId": 99001,
  "operationSucceeded": true,
  "errorMessage": null,
  "updateData": [
    {
      "op": "replace",
      "path": "/end",
      "value": "2026-01-31T20:00:00Z"
    }
  ]
}

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