Element details

type: meya.salesforce.cases.component.create
class: SalesforceCasesCreateComponent
path: /meya/salesforce/cases/component/create.py
signature: -

Fields

field	description	required	signature	default	type
spec	Override the original spec for this element.	○	○	null	Spec
description	A text description of the case.	○	○	null	str
comments	Used to insert a new CaseComment. Note: This is a single comment string, not a list of strings due to a misnomer in Salesforce API	○	○	null	str
contact_id	ID of the associated contact.	○	○	null	str
is_escalated	Indicates whether the case has been escalated (true) or not. A case's escalated state does not affect how you can use a case, or whether you can query, delete, or update it.	○	○	null	bool
origin	The source of the case, such as Email, Phone, or Web.	○	○	null	str
owner_id	ID of the contact who owns the case.	○	○	null	str
parent_id	The ID of the parent case in the hierarchy	○	○	null	str
priority	The importance or urgency of the case, such as High, Medium, or Low.	○	○	null	str
reason	The reason why the case was created, such as 'Instructions not clear' or 'User didn't attend training'.	○	○	null	str
source_id	The ID of the social post source.	○	○	null	str
status	The status of the case, such as New, Closed, or Escalated. This field directly controls the IsClosed flag.	○	○	null	str
subject	The subject of the case.	○	○	null	str
supplied_company	The company name that was entered when the case was created.	○	○	null	str
supplied_email	The email address that was entered when the case was created.	○	○	null	str
supplied_name	The name that was entered when the case was created.	○	○	null	str
supplied_phone	The phone number that was entered when the case was created.	○	○	null	str
case_type	The type of case, such as Feature Request or Question.	○	○	null	str
last_referenced_date	The timestamp when the current user last accessed this record, a record related to this record, or a list view.Accepted formats: YYYY-MM-DD, YYYY-MM-DDThh:mm:ss+hh:mm, YYYY-MM-DDThh:mm:ss-hh:mm or YYYY-MM-DDThh:mm:ssZ. Ready-only field you'll need special permission to edit this field.	○	○	null	str datetime NoneType
last_viewed_date	The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate) but not viewed it.Accepted formats: YYYY-MM-DD, YYYY-MM-DDThh:mm:ss+hh:mm, YYYY-MM-DDThh:mm:ss-hh:mm or YYYY-MM-DDThh:mm:ssZ. Ready-only field you'll need special permission to edit this field.	○	○	null	str datetime NoneType
master_record_id	If this object was deleted as the result of a merge, this field contains the ID of the record that was kept. If this object was deleted for any other reason, or has not been deleted, the value is null.Ready-only field you'll need special permission to change this field.	○	○	null	str
contact_mobile	Mobile telephone number for the contact. Ready-only field you'll need special permission to change this field.	○	○	null	str
contact_phone	Telephone number for the contact. Ready-only field you'll need special permission to change this field.	○	○	null	str
closed_date	The date and time when the case was closed.Accepted formats: YYYY-MM-DD, YYYY-MM-DDThh:mm:ss+hh:mm, YYYY-MM-DDThh:mm:ss-hh:mm or YYYY-MM-DDThh:mm:ssZ. Ready-only field you'll need special permission to edit this field.	○	○	null	str datetime NoneType
contact_email	Email address for the contact. Ready-only field you'll need special permission to edit this field.	○	○	null	str
contact_fax	Fax number for the contact. Ready-only field you'll need special permission to change this field	○	○	null	str
is_deleted	Indicates whether the object has been moved to the Recycle Bin (true) or not (false).Ready-only field you'll need special permission to change this field.	○	○	null	bool
custom_fields	Dictionary of name, value pairs used to set custom fields for the case object. Custom fields must be defined by your Salesforce administrator. Field names must be entered using the API Name (ex. HireDate__c).	○	○	null	dict
integration		◉	○		SalesforceCasesIntegrationRef
context	Send context data with this component's event.	○	○	{}	dict
sensitive		○	○	true	bool
triggers	Activate these dynamic triggers when the component runs. Check the component triggers guide for more info.	○	○	[]	list
send_transcript	Send the conversation transcript as a case comment to the case.	○	○	false	bool
account_id	The ID of the account associated with this case.	○	○	null	str
contact_first_name	The contact's first name. If not provided the contact's first name will be `Meya User`.	○	○	null	str
contact_last_name	The contact's last name. If not provided the contact's last name will be `id: MEYA_USER_ID`.	○	○	null	str
link	Links the current thread with the integration thread when `true`.This allows `salesforce.case.component.update` and `salesforce.case.component.add_comment` components to be used without the `case_id` parameter, also, this parameter will control whether new messages sent by user using orb should be relayed to the case (coming soon).	○	○	false	bool

Usage reference

Basic

triggers:
  - keyword: meya.salesforce.cases.component.create
steps:
  - type: meya.salesforce.cases.component.create
    integration: integration.salesforce_cases

Full

triggers:
  - keyword: meya.salesforce.cases.component.create
steps:
  - type: meya.salesforce.cases.component.create
    spec:
      type: STRING
      data:
        STRING: ANY
      timeout: 123
      trigger_when: ANY
    description: STRING
    comments: STRING
    contact_id: STRING
    is_escalated: false
    origin: STRING
    owner_id: STRING
    parent_id: STRING
    priority: STRING
    reason: STRING
    source_id: STRING
    status: STRING
    subject: STRING
    supplied_company: STRING
    supplied_email: STRING
    supplied_name: STRING
    supplied_phone: STRING
    case_type: STRING
    last_referenced_date: STRING
    last_viewed_date: STRING
    master_record_id: STRING
    contact_mobile: STRING
    contact_phone: STRING
    closed_date: STRING
    contact_email: STRING
    contact_fax: STRING
    is_deleted: false
    custom_fields:
      foo: bar
    integration: integration.salesforce_cases
    context:
      STRING: ANY
    sensitive: false
    triggers:
      - type: STRING
        data:
          STRING: ANY
        timeout: 123
        trigger_when: ANY
    send_transcript: false
    account_id: STRING
    contact_first_name: STRING
    contact_last_name: STRING
    link: false