Webhook details
Get the details of a webhook. Service implementations SHOULD take steps to avoid displaying URLs to users other than those who have suitable permissions (e.g. the owning user). Availability of this endpoint is indicated by the name "webhooks" appearing in the event_stream_mechanisms list on the /service endpoint.
Response
Return the webhook details.
The URL to which the service instance should make HTTP POST requests with event data
The HTTP header name that is added to the event POST
List of event types to receive
Limit Flow and Flow Segment events to Flows in the given list of Flow IDs
Limit Flow, Flow Segment and Source events to Sources in the given list of Source IDs
Limit Flow and Flow Segment events to those with Flow that is collected by a Flow Collection in the given list of Flow Collection IDs
Limit Flow, Flow Segment and Source events to those with Source that is collected by a Source Collection in the given list of Source Collection IDs
List of labels of URLs to include in the get_urls property in flows/segments_added events. Where multiple get_urls filter query parameters are provided, the included get_urls will match all filters. This option is the same as the accept_get_urls query parameter for the /flows/{flowId}/segments API endpoint, except that the labels are represented using a JSON array rather than a (comma separated list) string.
List of labels of storage_ids to include in the get_urls property in flows/segments_added events. Where multiple get_urls filter query parameters are provided, the included get_urls will match all filters. This option is the same as the accept_storage_ids query parameter for the /flows/{flowId}/segments API endpoint, except that the IDs are represented using a JSON array rather than a (comma separated list) string.
Whether to include presigned/non-presigned URLs in the get_urls property in flows/segments_added events. Where multiple get_urls filter query parameters are provided, the included get_urls will match all filters. This option is the same as the presigned query parameter for the /flows/{flowId}/segments API endpoint.
Whether to include storage metadata in the get_urls property in flows/segments_added events. This option is the same as the verbose_storage query parameter for the /flows/{flowId}/segments API endpoint.
If set to true, the underlying object's timerange should appear in flows/segments_added events. Assume false if omitted. This option is the same as the include_object_timerange query parameter for the /flows/{flowId}/segments API endpoint.
Key is a freeform string. Value is a freeform string, or an array of freeform strings.
A Universally Unique Identifier (UUID) as defined in RFC9562
Status of the Webhook. created indicates the webhook has been successfully registered but is yet to begin sending events or, depending on the service implementation, the worker responsible for sending the events has yet to start. started indicates the webhook is active and sending events. disabled indicates the webhook has been disabled by a client and is not currently sending events. error indicates an error condition has been encountered and the webhook has been disabled by the service instance. More information about the error condition will be indicated by the service instance in the error parameter. Service implementations SHOULD implement appropriate retries and only enter the error state when absolutely necesary. A webhook in the error or disabled state may be re-enabled by a client by setting the status to created. A webhook in the created or started state may be disabled by a client by setting the status to disabled. Attempting to transition an error status to disabled SHOULD be rejected.