Category: API
Summary: Existing Messaging Integration endpoints that don't use Async Creates are being deprecated. See https://developer.mypurecloud.com/api/rest/v2/conversations All POST endpoints for /api/v2/conversations/messaging/integrations/* need to use the async query param and pass the value as true
to create the integration in an Async manner.
Context: In order to prevent timeouts with 3rd parties during integration creation, we need to create the integrations in an async manner. This will allow the create process to finish creating in the background, and have the api user then poll for the createStatus
field to understand when the integration has finished processing. Valid statuses are Initiated
, Completed
, or Error
Impact: If you are not passing the async query param as true, for POST /api/v2/conversations/messaging/integrations/* endpoints , please change and start passing async param as true.
New workflow -
- POST to create the integration /api/v2/conversations/messaging/integrations/* passing async query param as
true
- The response will contain an
id
and acreateStatus
field. The initial createStatus will beInitiated
- GET the integration using the
id
returned in the POST response to poll for the status of the integration, and wait for the status to transition toCompleted
orError
before continuing with using the integration
Date of Change: 03/01/2021 - expected date of deprecation of non async integration create requests
Impacted APIs:
POST /api/v2/conversations/messaging/integrations/facebook
POST /api/v2/conversations/messaging/integrations/whatsapp
POST /api/v2/conversations/messaging/integrations/twitter
POST /api/v2/conversations/messaging/integrations/line