BokaMera.API.Host

<back to all web services

ListWebhookMessages

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
GET/webhook/messagesList webhook message
ListWebhookMessages Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?YesThe company id, if empty will use the company id for the user you are logged in with.
ListMessagesRequestDto Parameters:
NameParameterData TypeRequiredDescription
BeforeformDateTime?No
AfterformDateTime?No
ChannelformstringNo
IteratorformstringNo
Limitformint?No
OrderformOrdering?No
EventTypesformList<string>No
WithContentformbool?No
ClientWebhookRequestBase Parameters:
NameParameterData TypeRequiredDescription
ClientIdformGuidNo
Ordering Enum:
NameValue
Ascendingascending
Descendingdescending
ListMessagesResponseDto Parameters:
NameParameterData TypeRequiredDescription
DataformGetMessageResponseDto[]Yes
DoneformboolNo
IteratorformstringYes
GetMessageResponseDto Parameters:
NameParameterData TypeRequiredDescription
IdformstringYes
ChannelsformList<string>Yes
EventTypeformstringYes
MetadataformDictionary<string, string>No
PayloadformObjectYes
EventIdformstringYes
TimestampformDateTimeNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /webhook/messages HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Data: 
	[
		{
			Id: String,
			Channels: 
			[
				String
			],
			EventType: String,
			Metadata: 
			{
				String: String
			},
			Payload: {},
			EventId: String
		}
	],
	Done: False,
	Iterator: String
}