Types d’événements, exemples de contenus et référence des champs pour les webhooks de demandes d’exercice de droits Optacy.
Optacy prend actuellement en charge deux événements :
privacy_request.received
privacy_request.updated
Tous deux transmettent le dernier état de la demande d’exercice de droits. Pour une demande via Toll-Free Number (messagerie vocale), vous pouvez recevoir deux événements privacy_request.updated après la réception : l’un lorsque l’enregistrement est disponible, l’autre lorsque la transcription est prête.
{
"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"
}
}
Exemple : privacy_request.updated (messagerie vocale)
{
"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!"
}
}
Champs de la demande d’exercice de droits
| Clé | Description |
|---|
event_name | Chaîne, par ex. privacy_request.received |
signature | Objet contenant le jeton aléatoire, l’horodatage (ms) et la signature (voir Sécurité logicielle) |
id | UUID de la demande d’exercice de droits |
type | Chaîne, par ex. Voicemail ou WebForm |
primary_identifier | Identifiant principal de la demande |
consumer_email | E-mail utilisé pour communiquer avec le demandeur |
email_verified_at | Date de vérification de l’e-mail |
acknowledged | Indique si la demande a fait l’objet d’un accusé de réception |
verified | Indique si la demande est marquée comme vérifiée |
categorized | Indique si la demande est catégorisée (toujours true pour un formulaire web) |
completed | Indique si la demande a été traitée |
completed_rights | Correspondance entre les clés de droits et { completed, completed_at } |
extended | Indique si l’échéance a été prolongée |
deadline | Date d’échéance calculée à partir des Jurisdiction Rules, des prolongations et des droits non traités |
created_at / updated_at | Horodatages de la demande |
categorized_rights | Vue recommandée des droits : réponses et configuration des droits |
categorized_questions_data | Vue recommandée des réponses au formulaire : valeurs et configuration du Form Field Set |
categorized_country / categorized_state | Champs de juridiction recommandés (state vaut null hors des États-Unis) |
Service Code
| Clé | Description |
|---|
code | Service Code de cette demande |
name | Nom d’affichage du Service Code |
created_at / updated_at | Horodatages du Service Code |
Session d’appel (demandes via Toll-Free Number)
| Clé | Description |
|---|
created_at / ended_at | Heures de début d’appel et de raccrochage |
caller_id | Numéro de téléphone de l’appelant |
caller_name | Nom issu de la recherche CNAM |
caller_state | État américain déduit de l’indicatif régional, si disponible |
recording_status | completed lorsque les octets sont disponibles, ou failed |
mp3_encoded_bytes | Octets MP3 encodés en Base64 |
transcription_status | completed lorsque la transcription est prête |
transcription_text | Texte de la transcription |
| Clé | Description |
|---|
id | UUID de la session de formulaire web |
created_at | Date de réception du formulaire web |
remote_ip | Adresse IP du demandeur |
webform_questions_data / rights | Préférez plutôt categorized_questions_data et categorized_rights |
country_of_residence / state | Copiés dans les champs catégorisés de pays/État |