bookmark_borderHipChat Feed Meta

Introduction

The Feed Object meta for the HipChat add-on is an associative array containing the properties which determine how the add-on should process the form submission.

$feed['meta'] = array(
	'feed_name'                               => 'Your Feed Name',
	'color'                                   => 'yellow',
	'notify'                                  => false,
	'message'                                 => '<a href="{entry_url}">Entry #{entry_id} has been added.</a>',
	'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.

$conditional_logic_enabled = rgars( $feed, 'meta/feed_condition_conditional_logic' );

Properties

  • feed_name string

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

  • room string

    The HipChat ID for the Room this feed will post a notification to.

  • color string

    The color the notification will be displayed as. Possible values: yellow, green, red, purple, grey or random

  • notify boolean

    Should users in the room be notified (change the tab color, play a sound, etc) when the message is posted. Default is false.

  • message string

    The message that will be posted to HipChat. Can contain merge tags.

  • 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.