Optacy-Webhooks entwickeln

Event-Typen, Beispiel-Payloads und Feldreferenz für Optacy-Webhooks zu Datenschutzanfragen.

Optacy unterstützt derzeit zwei Events:

privacy_request.received
privacy_request.updated

Beide enthalten den neuesten Stand der Datenschutzanfrage. Bei einer Anfrage über die Toll-Free Number (Voicemail) erhalten Sie nach dem Eingang möglicherweise zwei privacy_request.updated-Events: eines, wenn die Aufnahme verfügbar ist, und ein weiteres, wenn die Transkription bereitsteht.

Beispiel: privacy_request.received (Webformular)

{
  "event_name": "privacy_request.received",
  "signature": {
    "random_token": "b39a5c7ac85ec479f921cdfaae4b4eee",
    "timestamp": "1584300477293",
    "signature": "599a40fb2d25f995a40dc43f725a57be4e8df90"
  },
  "id": "4e2c7dcd-8277-40bb-1082-66c7cb417df2",
  "type": "WebForm",
  "primary_identifier": "john@doe.com",
  "consumer_email": "john@doe.com",
  "email_verified_at": "2025-01-01",
  "acknowledged": true,
  "categorized": false,
  "verified": false,
  "extended": false,
  "completed": false,
  "completed_rights": {
    "data_categories_request": { "completed": false, "completed_at": null },
    "do_not_sell": { "completed": true, "completed_at": "2025-01-01" },
    "erase_my_information": { "completed": false, "completed_at": null },
    "send_me_a_copy_of_information": { "completed": false, "completed_at": null },
    "other": { "completed": false, "completed_at": null }
  },
  "deadline": "2025-07-02",
  "created_at": "2025-05-18T17:36:44.399Z",
  "updated_at": "2025-05-18T17:36:45.187Z",
  "categorized_country": "USA",
  "categorized_state": "California",
  "service_code": {
    "code": 1,
    "name": "Example Brand",
    "created_at": "2024-07-16T20:31:24.915Z",
    "updated_at": "2025-05-18T16:40:19.894Z"
  },
  "jurisdiction_rule": {
    "name": "USA only",
    "description": "Description of applied Jurisdiction Rule",
    "created_at": "2025-05-17T18:48:59.391Z",
    "days_to_process": 45,
    "notes": "Available in the Jurisdictions tab in the dashboard."
  },
  "web_form_session": {
    "id": "904c1b30-2ba8-49cf-a349-46f7c6b29e70",
    "created_at": "2025-05-18T17:36:44.394Z",
    "remote_ip": "24.102.96.226"
  }
}

Beispiel: privacy_request.updated (Voicemail)

{
  "event_name": "privacy_request.updated",
  "signature": {
    "random_token": "a021778c09cdae8897859340d3f0b32f",
    "timestamp": "1584305606907",
    "signature": "201de4703b7ce1eb33878fa29d77d8572ddeb2af"
  },
  "id": "abf78bbb-a152-4f09-90ad-5802f53721d7",
  "type": "Voicemail",
  "primary_identifier": "john@doe.com",
  "consumer_email": "john@doe.com",
  "acknowledged": false,
  "categorized": false,
  "verified": true,
  "extended": false,
  "completed": true,
  "deadline": "2019-11-05",
  "created_at": "2019-09-21 16:31:11 UTC",
  "updated_at": "2020-03-15 20:48:05 UTC",
  "categorized_country": "USA",
  "categorized_state": "California",
  "service_code": {
    "code": "2",
    "name": "test",
    "created_at": "2019-09-21 16:31:11 UTC",
    "updated_at": "2020-01-26 05:59:40 UTC"
  },
  "call_session": {
    "created_at": "2019-09-21 16:31:11 UTC",
    "ended_at": "2019-09-21 16:33:11 UTC",
    "caller_id": "+15555555555",
    "caller_name": "John Smith",
    "caller_state": "CA",
    "recording_status": "completed",
    "mp3_encoded_bytes": "",
    "transcription_status": "completed",
    "transcription_text": "Hello world!"
  }
}

Felder der Datenschutzanfrage

Schlüssel	Beschreibung
`event_name`	String, z. B. `privacy_request.received`
`signature`	Objekt mit zufälligem Token, Zeitstempel (ms) und Signatur (siehe Softwaresicherheit)
`id`	UUID der Datenschutzanfrage
`type`	String, z. B. `Voicemail` oder `WebForm`
`primary_identifier`	Primärer Identifikator der Anfrage
`consumer_email`	E-Mail-Adresse für die Kommunikation mit der anfragenden Person
`email_verified_at`	Zeitpunkt, zu dem die E-Mail-Adresse verifiziert wurde
`acknowledged`	Ob der Eingang der Anfrage bestätigt wurde
`verified`	Ob die Anfrage als verifiziert markiert ist
`categorized`	Ob die Anfrage kategorisiert ist (bei Webformularen immer true)
`completed`	Ob die Anfrage abgeschlossen wurde
`completed_rights`	Zuordnung von Rechte-Schlüsseln zu `{ completed, completed_at }`
`extended`	Ob die Frist verlängert wurde
`deadline`	Fälligkeitsdatum aus Jurisdiction Rules, Verlängerungen und noch nicht erfüllten Rechten
`created_at` / `updated_at`	Zeitstempel der Anfrage
`categorized_rights`	Bevorzugte Ansicht der Rechte: Antworten plus Konfiguration der Rechte
`categorized_questions_data`	Bevorzugte Ansicht der Formularantworten: Werte plus Konfiguration des Form Field Sets
`categorized_country` / `categorized_state`	Bevorzugte Felder für die Jurisdiktion (`state` ist außerhalb der USA null)

Service Code

Schlüssel	Beschreibung
`code`	Service Code dieser Anfrage
`name`	Anzeigename des Service Codes
`created_at` / `updated_at`	Zeitstempel des Service Codes

Call Session (Anfragen über die Toll-Free Number)

Schlüssel	Beschreibung
`created_at` / `ended_at`	Beginn des Anrufs und Zeitpunkt des Auflegens
`caller_id`	Telefonnummer des Anrufers
`caller_name`	Name aus der CNAM-Abfrage
`caller_state`	US-Bundesstaat anhand der Vorwahl, sofern verfügbar
`recording_status`	`completed`, wenn die Bytes verfügbar sind, oder `failed`
`mp3_encoded_bytes`	Base64-codierte MP3-Bytes
`transcription_status`	`completed`, wenn die Transkription bereitsteht
`transcription_text`	Text der Transkription

Web Form Session

Schlüssel	Beschreibung
`id`	UUID der Web Form Session
`created_at`	Zeitpunkt, zu dem das Webformular eingegangen ist
`remote_ip`	IP-Adresse der anfragenden Person
`webform_questions_data` / `rights`	Verwenden Sie stattdessen bevorzugt `categorized_questions_data` und `categorized_rights`
`country_of_residence` / `state`	Werden in die kategorisierten Felder für Land/Bundesstaat übernommen