AWaws-samples
Webhooks

Webhook details

Changed on

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.

get/service/webhooks/{webhookId}

Request

  • Base URL
    http://localhost:4010
  • URL
    http://localhost:4010/service/webhooks/{webhookId}
  • Auth
    • HTTP bearer
    • or API key in query parameter access_token
    • or HTTP basic

Response

Return the webhook details.

urlstring required

The URL to which the service instance should make HTTP POST requests with event data

api_key_namestring

The HTTP header name that is added to the event POST

eventsstring[] required

List of event types to receive

flow_idsUuid[]

Limit Flow and Flow Segment events to Flows in the given list of Flow IDs

source_idsUuid[]

Limit Flow, Flow Segment and Source events to Sources in the given list of Source IDs

flow_collected_by_idsUuid[]

Limit Flow and Flow Segment events to those with a Flow that is collected by a Flow Collection in the given list of Flow Collection IDs. An empty array limits events to Flows that are not collected by any Flow Collection.

source_collected_by_idsUuid[]

Limit Flow, Flow Segment and Source events to those with a Source that is collected by a Source Collection in the given list of Source Collection IDs. An empty array limits events to Sources that are not collected by any Source Collection.

accept_get_urlsstring[]

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.

accept_storage_idsUuid[]

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.

presignedboolean

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.

verbose_storageboolean

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.

include_object_timerangeboolean

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.

tagsTags

Key is a freeform string. Value is a freeform string, or an array of freeform strings.

idstring required

A Universally Unique Identifier (UUID) as defined in RFC9562

status'created' | 'started' | 'disabled' | 'error' required

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.

Changes

  • 3b6c8b10d051Revision changes
    • info

      added the optional property // to the response with the status

  • 552be51d35bdRevision changes
    • breaking

      removed 'propertyNames' constraint from the // response property for the status