API V3Webhook events
General correspondence document sent/bounced/sequence ended/not read
Webhook triggered when a general correspondence document message is sent, bounced, when the sequence ends, or when the sequence message is not read after set days. Contact POM to set up this webhook for your account.
Authorization
AuthorizationstringheaderrequiredOAuth 2.0 client credentials Grant
Body
application/json
The new GeneralCorrespondenceDocument resource
id_clientintegerdebtornumberstringmpidintegerpayment_referenceany | nullid_request_clientstring | nullevent_typeenum<string>One of:general_correspondence_sequence_bouncegeneral_correspondence_sequence_sentgeneral_correspondence_sequence_endgeneral_correspondence_sequence_not_readdocument_idintegersequence_idintegersequence_numberintegerchannelenum<string>One of:emailletteremail_addressstring | nullemail_template_idinteger | nullemail_subjectstring | nulladdress_streetstring | nulladdress_numberstring | nulladdress_citystring | nulladdress_postcodestring | nulladdress_countrystring | nullis_registeredboolean
Example payload
{
"id_client": 1234,
"debtornumber": "D-1000",
"mpid": 1000000000,
"payment_reference": "PAY-123456",
"id_request_client": "REQ-123456",
"document_id": 123,
"sequence_id": 321,
"sequence_number": 1,
"email_address": "[email protected]",
"email_template_id": 100,
"email_subject": "Subject of the email",
"address_street": "Van Coulsterweg",
"address_number": "2A",
"address_city": "Alblasserdam",
"address_postcode": "2952CB",
"address_country": "NL",
"is_registered": true
}Your response
application/json
GeneralCorrespondenceDocument resource created
object