Process actor webhooks | API

Created by Hannah Rowe, Modified on Fri, 16 Aug, 2024 at 12:44 PM by Hannah Rowe

 

Process actor webhooks are used to call back to external systems with updates on the status of an invite. 



Configuring your webhook URL 


The process actor webhook URL is set per Credas portal and must be set by your technical contact. 


However, resellers can set this value within a child portal.  Please contact your technical contact for more information on this. 



JSON example

 

A HTTP post will be sent to the configured webhook URL on completion of the process. 

 

An example of the JSON post body is below:


{

    "clientId": "75e7fa46-7c93-4d2e-86ee-727737c6f482",

    "processId": "9afe8b16-0b4d-4da3-a7d3-353c7ebece0d",

    "processActorId": 11014,

    "entityId": "3bd81445-a87d-4aa1-9f1d-72afc60fa414",

    "smsStatus": 2,

    "smsStatusDescription": "Delivered",

    "emailStatus": 2,

    "emailStatusDescription": "Delivered"

}


You should use the entityId & processId value included within this POST body to identity the relevant process. 


Note: You will receive a several status updates per process as communications progress from 'not sent' to 'sent', 'delivered' and so forth. 


Status values


To interpret the smsStatus value please use the below table:
 

ID

Status

Description

0

Not sent

SMS not sent

1

Sent

SMS sent

2
 

Delivered

SMS delivered successfully

5

Bounced

SMS delivery failed

 

To interpret the emailStatus value please use the below table:
 

ID

Status

Description

0

Not sent

Email not sent

1

Sent

Email sent

2
 

Delivered

Email delivered successfully

3

Opened

Email opened*
 

5

Bounced

Email delivery failed


Where possible Credas will provide an opened notification however this is not always possible due to email provider limitations. 



Example use case

 

Our process actors webhook is commonly used to determine whether an end user has successfully received their email and/or SMS invitation.

 

Where a value of 5 ('Bounced') is returned you may wish to take action to ensure you hold the correct contact information for the end user and reissue an invitation.


Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article

Join our live training sessions

Whether you're new to Credas or simply looking for a refresher, we’ve got you covered! We now offer regular training sessions designed to help you get the most out of the Credas platform. These sessions are tailored to different product areas, including:

- AML / ID verification
- Right to Work
- Our brand-new Credas Lettings solution
- Admin / advanced training

In each session we will walk you through how platform works and answer any questions you may have.

See our full training schedule