Skip to content
flinkeyflinkey for Developers

Assignment deleted result

POST
/webhooks/assignmentDeletedResult
curl --request POST \
  --url https://api-uat.flinkey.de/v3/webhooks/assignmentDeletedResult \
  --header 'Content-Type: application/json' \
  --data '{ "checksum": "abc123def456", "assignmentId": 77001, "customerId": 99001, "operationSucceeded": true, "errorMessage": null }'

Purpose

Receive the asynchronous result of an assignment deletion request.

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

Assignment deletion is asynchronous.

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

Typical situations:

  • confirming that an assignment deletion was processed successfully,
  • marking a local assignment as deleted,
  • marking a local assignment deletion as failed,
  • storing errorMessage for troubleshooting,
  • reconciling pending assignment deletion requests,
  • deciding whether access should still be shown as available in the partner system,
  • removing or disabling mobile access context after successful assignment deletion.

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

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

Validation notes

PROD validation result:

  • The configured delete-result endpoint received an HTTP POST after the assignment delete API returned 204 No Content.
  • The incoming request used Content-Type: application/json; charset=utf-8.
  • The successful payload contained checksum, numeric assignmentId, numeric customerId, operationSucceeded: true and errorMessage: null.
  • No secret was configured for the delete-result endpoint during this validation; each webhook endpoint has its own secret configuration field in the portal.

Async behavior

This webhook is the asynchronous result of Delete assignment.

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

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

Webhook result

Yes.

This entry describes the assignment deleted result webhook.

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

boolean
errorMessage
required

Error message if the operation failed

string | null
Example
{
  "checksum": "abc123def456",
  "assignmentId": 77001,
  "customerId": 99001,
  "operationSucceeded": true,
  "errorMessage": 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