Create (or update) a user in Zendesk Support.

Here is an example of how to use this component to create a user using
their email:

triggers:
  - keyword: zendesk_user_create_or_update

steps:
  - say: Creating or updating user using email...
  - type: meya.zendesk.support.component.user.create_or_update
    integration: integration.zendesk.support
    link: true
    email: [email protected]

  - say: User (@ flow.result.id ) created or updated

Element details

type: meya.zendesk.support.component.user.create_or_update
class: ZendeskSupportUserCreateOrUpdateComponent
path: /meya/zendesk/support/component/user/create_or_update.py
signature: -

Fields

field	description	required	signature	default	type
spec	Override the original spec for this element.	○	○	null	Spec
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
integration	The reference path to the Zendesk Support integration file. See the integration reference paths documentation for more information.	◉	○		ZendeskSupportIntegrationRef
link	Whether to link the user to the current Meya user. This will use the Zendesk user ID returned from the API response as the integration user ID for Meya to link to.	○	○	true	bool
name	The user's name.	○	○	null	str
details	Any details you want to store about the user, such as an address	○	○	null	str
email	The user's primary email address. Writeable on create only. On update, a secondary email is added. See the Zendesk email address documentation for more information.	○	○	null	str
verified	Whether any of the user's identities have been verified.	○	○	null	bool
phone	The user's primary phone number. See the Zendesk phone number documentation for more information.	○	○	null	str
tags	An array of tags to add to the user. This is only present if user tagging is enabled for your Zendesk instance.	○	○	null	list
user_fields	Values of custom fields in the user's profile. See the Zendesk user fields documentation for more information.	○	○	null	dict
external_id	An ID you can use to link Zendesk Support users to local records. Note, the Zendesk API treats the ID as case sensitive.	○	○	null	str

Usage reference

Basic

triggers:
  - keyword: meya.zendesk.support.component.user.create_or_update
steps:
  - type: meya.zendesk.support.component.user.create_or_update
    integration: integration.zendesk_support

Full

triggers:
  - keyword: meya.zendesk.support.component.user.create_or_update
steps:
  - type: meya.zendesk.support.component.user.create_or_update
    spec:
      type: STRING
      data:
        STRING: ANY
      timeout: 123
      trigger_when: ANY
    context:
      STRING: ANY
    sensitive: false
    triggers:
      - type: STRING
        data:
          STRING: ANY
        timeout: 123
        trigger_when: ANY
    integration: integration.zendesk_support
    link: false
    name: STRING
    details: STRING
    email: STRING
    verified: false
    phone: STRING
    tags:
      - STRING
    user_fields:
      STRING: ANY
    external_id: STRING