Embed
EASI’R Embed is a way of making the EASI'R platform accessible externally.
What Embed is used for
In its current form, it is possible to call Embed with a set of parameters, to create an activity on a case.
The user will be shown a simplified version of the create activity view. Based on the given parameters, contents of the view will be pre-filled.
Technical notes and requirements
- It is assumed that the user is already logged in
- Keep in mind that URLs have a recommended maximum length of 2048 characters (source)
- Make sure to escape parameters like & and ? to avoid breaking the url
- A
case_id
UUID must be provided from an existing case
URL Parameters
activity_type
string- Must be either
call
,meeting
,email
orletter
- Must be either
activity_type_ids
comma separated UUID's- Must be a valid UUID and an existing milestone on the case relations path
- Required
note
stringtask_type
string- Must be either
email
,letter
,call
,meeting
orremind_me
- Must be either
task_start_at
date- Y-m-d H:i:s format
- Must be after "now"
- Required when
task_type
is given
task_end_at
date- Y-m-d H:i:s format
- Must be after
task_start_at
- Required when
task_type
is given
content_suggestion_id
UUID- Must be a valid UUID and an existing content suggestion on a given
activity_type_ids
- Must be a valid UUID and an existing content suggestion on a given
product_ids
comma separated UUID's- Must be a valid UUID and an existing product
attachment_ids
comma separated UUID's- Must be a valid UUID and an attachment
content_suggestion_id
is required whenattachment_ids
is givencontent_suggestion_id
must be of the type email
URL
https://app.easir.com/embed/cases/:case_id/activity/:activity_type?:url parameters