Help Scout Feed Meta

Introduction

The Feed Meta object for the Help Scout Add-On is an associative array containing the properties which determine how the add-on should process the form submission.

1
2
3
4
5
6
7
$feed['meta'] = array(
    'feed_name'                               => 'Your Feed Name',
    'feed_condition_conditional_logic'        => true,
    'feed_condition_conditional_logic_object' => array(
        'conditionalLogic' => array(),
    ),
);

Usage

We recommend accessing the $feed meta using the rgar() or rgars() functions, e.g.:

1
2
3
4
5
6
7
8
9
10
11
12
13
$conditional_logic_enabled = rgars( $feed, 'meta/feedCondition' );
 
if ( $conditional_logic_enabled ) {
    // Conditional logic is enabled for this feed.
    $logic_rules = rgars( $feed, 'meta/feed_condition_conditional_logic_object/conditionalLogic/rules' );
    foreach ( $logic_rules as $rule ) {
        // Process each conditional logic rule.
        $field_id  = rgar( $rule, 'fieldId' );
        $operator  = rgar( $rule, 'operator' );
        $value     = rgar( $rule, 'value' );
        // Example: Use $field_id, $operator, and $value in your logic.
    }
}

Properties

  • feed_name string

    The feed name which appears on the add-ons feeds tab.

  • mailbox string

    The Help Scout ID of the Mailbox the conversation will be added to.

  • user string

    The Help Scout ID of the User the conversation should be assigned to.

  • status string

    The conversation status. Possible values: active, pending, closed or spam.

  • type string

    The conversation type. Possible values: email, chat or phone.

  • customer_email string

    The ID of the field containing the customer’s email address.

  • customer_first_name string

    The ID of the field containing the customer’s first name.

  • customer_last_name string

    The ID of the field containing the customer’s last name.

  • tags string

    A comma separated string containing the tags the conversation should be assigned. Merge tags are supported.

  • subject string

    The conversation subject line. Merge tags are supported.

  • body string

    The conversation message. Merge tags are supported.

  • attachments array

1
2
3
4
array(
        '10' => true,
        '11' => false,
);

An array of file upload fields. The field ID is the key with a boolean value indicating if the files for that field should be attached.

  • cc string
    A comma separated string containing the emails the conversation should be cc’d to. Merge tags are supported.
  • bcc string
    A comma separated string containing the emails the conversation should be bcc’d to. Merge tags are supported.
  • auto_reply boolean
    Should Help Scout send an auto reply when the message is created. Default false. Added in Help Scout 1.2.
  • feed_condition_conditional_logic boolean
    Is the feed condition (conditional logic) setting enabled. Default is false.
  • feed_condition_conditional_logic_object array
    An associative array containing the conditional logic rules. See the Conditional Logic Object for more details.