WebhooksConfigDto

One webhook subscription of the portal: where deliveries go, which events they cover, and how they have fared.

Name	Type	Description	Notes
id	Integer (int32)	The identifier of the subscription, which is what PUT api/2.0/settings/webhook, DELETE api/2.0/settings/webhook/{id} and the configId filter of the delivery log address it by.	[required] [example: 1]
name	String	The label the subscription was given, free text with no meaning to the portal.	[optional] [example: Room activity] [nullable]
uri	String	The address every delivery is posted to. The signing secret that lets the receiver verify a delivery is never part of this answer, so it has to be kept from the moment the subscription was created.	[optional] [example: https://example.com/hooks/docspace] [nullable]
enabled	Boolean	Whether the subscription is delivering. While it is false events are dropped rather than queued, so nothing arrives late after it is switched back on.	[optional] [example: true]
ssl	Boolean	Whether the certificate of uri is verified before a delivery. While it is false a self-signed certificate is accepted as well.	[optional] [example: true]
triggers	WebhookTrigger	The events the subscription covers, as the bits of GET api/2.0/settings/webhook/triggers added together. 0 is the catch-all and means every event, not none.	[optional] [enum: 0, 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608, 16777216, 33554432, 67108864, 134217728, 268435456, 536870912, 1073741824]
targetId	String	The single room or file the subscription is narrowed to, empty for a subscription that covers the whole portal. It is kept as an opaque value, so both a numeric and a third-party identifier can appear.	[optional] [example: 00000000-0000-0000-0000-000000000001] [nullable]
createdBy	EmployeeDto	The member who created the subscription, which is also who a non-administrator is limited to seeing. It is empty for a subscription created by a portal background job.	[optional]
createdOn	Date (date-time)	When the subscription was created, in the portal time zone.	[optional] [example: 2024-01-15T10:30:00Z] [nullable]
modifiedBy	EmployeeDto	The member who last changed the subscription, empty while nobody has changed it since it was created.	[optional]
modifiedOn	Date (date-time)	When it was last changed, in the portal time zone, and empty under the same condition as modifiedBy.	[optional] [example: 2024-01-15T10:30:00Z] [nullable]
lastFailureOn	Date (date-time)	When a delivery last failed, in the portal time zone. It is empty for a subscription that has never failed, and it is not cleared by a later success - compare it with lastSuccessOn to see which came last.	[optional] [example: 2024-01-15T10:30:00Z] [nullable]
lastFailureContent	String	What the target answered on that failure, truncated, for diagnosing without opening the delivery log. It is empty when the failure produced no body at all, a timeout for instance.	[optional] [example: 502 Bad Gateway] [nullable]
lastSuccessOn	Date (date-time)	When a delivery last succeeded, in the portal time zone, empty for a subscription that has never delivered. Both this and lastFailureOn being empty means nothing has been attempted yet.	[optional] [example: 2024-01-15T10:30:00Z] [nullable]