Webhook external systems

GET /api/groups/:group_id/webhooks

Success Response Code: 200

Params

Param name Description
group_id
optional

id of the group


Value: Must be Integer
page
optional

page number of external_systems to be returned (default=1)


Value: Must be Integer
per_page
optional

number of external_systems to be returned per page (default=20, max=500)


Value: Must be Integer

Response Fields

external_systems all of the webhooks in the current group (see #create for details) Array<WebhookSystem>

Example Curl Commands

curl -X GET -v --basic -u "emily@socialcast.com:demo" https://demo.socialcast.com/api/groups/4/webhooks.json

POST /api/groups/:group_id/webhooks

Success Response Code: 201

Params

Param name Description
name
required

the name for the webhook system


Value: Must be String
description
optional

details about the webhook system


Value: Must be String
webhook_type
required

type of webhook system to create


Value: Must be one of: <code>airbrake</code>, <code>codestream</code>, <code>generic_webhook</code>, <code>github</code>, <code>jenkins</code>, <code>jira</code>, <code>loginsight</code>, <code>newrelic</code>, <code>pagerduty</code>, <code>vrealize_operations_manager_alert</code>, <code>vsphere_alarm</code>.
profile_photo_url
optional

set the profile photo for the webhook system from this link


Value: Must be String

Response Fields

id id of the webhook system Integer
avatars urls for the webhook system's avatar in various sizes Hash<String, String>
name the name of the webhook system String
description the description of the webhook system String
group_id the ID of the group containing the external system Integer
webhook_type the type of webhooks the webhook system can consume ["airbrake", "codestream", "generic_webhook", "github", "jenkins", "jira", "loginsight", "newrelic", "pagerduty", "vrealize_operations_manager_alert", "vsphere_alarm"]

Example Curl Commands

curl -X POST -v --basic -u "emily@socialcast.com:demo" https://demo.socialcast.com/api/groups/4/webhooks.json -d'{"name": "jira webhook", "description": "updates from our jira instance", "webhook_type": "jira"}'