Webhook.md

SunshineConversationsClient::Webhook

Properties

Name	Type	Description	Notes
id	String	A unique identifier for the webhook.	[optional][readonly]
version	String	Schema version of the payload delivered to this webhook. Can be `v1`, `v1.1` or `v2`.	[optional][readonly]
target	String	URL to be called when the webhook is triggered.
triggers	Array<String>	An array of triggers the integration is subscribed to. This property is case sensitive. More details.
secret	String	Webhook secret, used to verify the origin of incoming requests.	[optional]
include_full_user	Boolean	A boolean specifying whether webhook payloads should include the complete user schema for events involving a specific user.	[optional][default to false]
include_full_source	Boolean	A boolean specifying whether webhook payloads should include the client and device object (when applicable).	[optional][default to false]

Example

require 'sunshine-conversations-client'

instance = SunshineConversationsClient::Webhook.new(
  id: 5e554d2cac66fb73a3c01871,
  version: v2,
  target: https://example.com/callback,
  triggers: ["conversation:read","conversation:message"],
  secret: 8564b3e6a8b20a4bdb68b05ce9bc5936,
  include_full_user: null,
  include_full_source: null
)