API for delivering and managing webhooks.
ListWebhooks
https:/ / api.cloud.hashicorp.com/ 2023-05-31/ webhook/ {parent_resource_name}/ webhooks
The max number of results per page that should be returned. If the number
of available results is larger than page_size
, a next_page_token
is
returned which can be used to get the next page of results in subsequent
requests. A value of zero will cause page_size
to be defaulted.
Specifies a page token to use to retrieve the next page. Set this to the
next_page_token
returned by previous list requests to get the next page of
results. If set, previous_page_token
must not be set.
Specifies a page token to use to retrieve the previous page. Set this to
the previous_page_token
returned by previous list requests to get the
previous page of results. If set, next_page_token
must not be set.
Specifies the list of per field ordering that should be used for sorting. The order matters as rows are sorted in order by fields and when the field matches, the next field is used to tie break the ordering. The per field default ordering is ascending.
The fields should be immutabile, unique, and orderable. If the field is not unique, more than one sort fields should be passed.
Example: oder_by=name,age desc,created_at asc In that case, 'name' will get the default 'ascending' order.
The information about a webhook subscription.
A webhook can either provide the resource_id
to subscribe to events generated by a specific resource,
or they can subscribe to the available events for all resources in the webhook's project when the resource_id
is omitted.
The information about an event type of a webhook subscription.
The information about a webhook delivery, such as the sent request, the received response, and how many times the webhook service retried to send the delivery in case of failure.
The information about the request made to deliver an event payload.
The payload that is delivered as the body of the request made to the webhook's destination URL.
Refers to the source of the event, for example hashicorp.packer.version
.
The event source type may differ from the resource that the webhook is subscribed to when the event is from a
descendent resource.
For example, webhooks subscribed to hashicorp.packer.registry
receive events for the descendant's resources,
such as a hashicorp.packer.version
.
PaginationResponse is the response holding the page tokens for a paginated list response.
This token allows you to get the previous page of results for list
requests. If the number of results is larger than page_size
, use the
previous_page_token
as a value for the query parameter
previous_page_token
in the next request. The value will become empty when
there are no more pages.
CreateWebhook
https:/ / api.cloud.hashicorp.com/ 2023-05-31/ webhook/ {parent_resource_name}/ webhooks
The information about a webhook subscription.
A webhook can either provide the resource_id
to subscribe to events generated by a specific resource,
or they can subscribe to the available events for all resources in the webhook's project when the resource_id
is omitted.
The information about an event type of a webhook subscription.
The payload that is delivered as the body of the request made to the webhook's destination URL.
Refers to the source of the event, for example hashicorp.packer.version
.
The event source type may differ from the resource that the webhook is subscribed to when the event is from a
descendent resource.
For example, webhooks subscribed to hashicorp.packer.registry
receive events for the descendant's resources,
such as a hashicorp.packer.version
.
When set to 'true', a verification request will be sent and the webhook created enabled and only if the verification succeeds. When set to 'false', the webhook configuration won't be verified and the webhook created disabled. When left unset, a verification request will be sent and the webhook will be created enabled if it succeeds, or disabled if it fails.
The information about a webhook subscription.
A webhook can either provide the resource_id
to subscribe to events generated by a specific resource,
or they can subscribe to the available events for all resources in the webhook's project when the resource_id
is omitted.
The information about an event type of a webhook subscription.
The information about a webhook delivery, such as the sent request, the received response, and how many times the webhook service retried to send the delivery in case of failure.
The information about the request made to deliver an event payload.
The payload that is delivered as the body of the request made to the webhook's destination URL.
Refers to the source of the event, for example hashicorp.packer.version
.
The event source type may differ from the resource that the webhook is subscribed to when the event is from a
descendent resource.
For example, webhooks subscribed to hashicorp.packer.registry
receive events for the descendant's resources,
such as a hashicorp.packer.version
.
ListWebhookDeliveries
https:/ / api.cloud.hashicorp.com/ 2023-05-31/ {parent_resource_name}/ deliveries
The max number of results per page that should be returned. If the number
of available results is larger than page_size
, a next_page_token
is
returned which can be used to get the next page of results in subsequent
requests. A value of zero will cause page_size
to be defaulted.
Specifies a page token to use to retrieve the next page. Set this to the
next_page_token
returned by previous list requests to get the next page of
results. If set, previous_page_token
must not be set.
Specifies a page token to use to retrieve the previous page. Set this to
the previous_page_token
returned by previous list requests to get the
previous page of results. If set, next_page_token
must not be set.
Specifies the list of per field ordering that should be used for sorting. The order matters as rows are sorted in order by fields and when the field matches, the next field is used to tie break the ordering. The per field default ordering is ascending.
The fields should be immutabile, unique, and orderable. If the field is not unique, more than one sort fields should be passed.
Example: oder_by=name,age desc,created_at asc In that case, 'name' will get the default 'ascending' order.
The information about a webhook delivery, such as the sent request, the received response, and how many times the webhook service retried to send the delivery in case of failure.
The information about the request made to deliver an event payload.
The payload that is delivered as the body of the request made to the webhook's destination URL.
Refers to the source of the event, for example hashicorp.packer.version
.
The event source type may differ from the resource that the webhook is subscribed to when the event is from a
descendent resource.
For example, webhooks subscribed to hashicorp.packer.registry
receive events for the descendant's resources,
such as a hashicorp.packer.version
.
PaginationResponse is the response holding the page tokens for a paginated list response.
This token allows you to get the previous page of results for list
requests. If the number of results is larger than page_size
, use the
previous_page_token
as a value for the query parameter
previous_page_token
in the next request. The value will become empty when
there are no more pages.
GetWebhook
https:/ / api.cloud.hashicorp.com/ 2023-05-31/ {resource_name}
The information about a webhook subscription.
A webhook can either provide the resource_id
to subscribe to events generated by a specific resource,
or they can subscribe to the available events for all resources in the webhook's project when the resource_id
is omitted.
The information about an event type of a webhook subscription.
The information about a webhook delivery, such as the sent request, the received response, and how many times the webhook service retried to send the delivery in case of failure.
The information about the request made to deliver an event payload.
The payload that is delivered as the body of the request made to the webhook's destination URL.
Refers to the source of the event, for example hashicorp.packer.version
.
The event source type may differ from the resource that the webhook is subscribed to when the event is from a
descendent resource.
For example, webhooks subscribed to hashicorp.packer.registry
receive events for the descendant's resources,
such as a hashicorp.packer.version
.
DeleteWebhook
https:/ / api.cloud.hashicorp.com/ 2023-05-31/ {resource_name}
UpdateWebhook
https:/ / api.cloud.hashicorp.com/ 2023-05-31/ {resource_name}
The information about a webhook subscription.
A webhook can either provide the resource_id
to subscribe to events generated by a specific resource,
or they can subscribe to the available events for all resources in the webhook's project when the resource_id
is omitted.
The information about an event type of a webhook subscription.
The information about a webhook delivery, such as the sent request, the received response, and how many times the webhook service retried to send the delivery in case of failure.
The information about the request made to deliver an event payload.
The payload that is delivered as the body of the request made to the webhook's destination URL.
Refers to the source of the event, for example hashicorp.packer.version
.
The event source type may differ from the resource that the webhook is subscribed to when the event is from a
descendent resource.
For example, webhooks subscribed to hashicorp.packer.registry
receive events for the descendant's resources,
such as a hashicorp.packer.version
.
The required mask of webhook fields to update. The endpoint converts field names to the lower-camel naming convention.
Fields that you can update are description
, config
, subscriptions
, and enabled
.
Example of usage:
"description,config"
updates the description, config.url
, and config.hmac_key
."config.hmacKey"
only updates config.hmac_key
."description,config,subscriptions,enabled"
update all allowed fields.The payload that is delivered as the body of the request made to the webhook's destination URL.
Refers to the source of the event, for example hashicorp.packer.version
.
The event source type may differ from the resource that the webhook is subscribed to when the event is from a
descendent resource.
For example, webhooks subscribed to hashicorp.packer.registry
receive events for the descendant's resources,
such as a hashicorp.packer.version
.
The information about a webhook subscription.
A webhook can either provide the resource_id
to subscribe to events generated by a specific resource,
or they can subscribe to the available events for all resources in the webhook's project when the resource_id
is omitted.
The information about an event type of a webhook subscription.
The information about a webhook delivery, such as the sent request, the received response, and how many times the webhook service retried to send the delivery in case of failure.
The information about the request made to deliver an event payload.
The payload that is delivered as the body of the request made to the webhook's destination URL.
Refers to the source of the event, for example hashicorp.packer.version
.
The event source type may differ from the resource that the webhook is subscribed to when the event is from a
descendent resource.
For example, webhooks subscribed to hashicorp.packer.registry
receive events for the descendant's resources,
such as a hashicorp.packer.version
.
UpdateWebhookName
https:/ / api.cloud.hashicorp.com/ 2023-05-31/ {resource_name}/ name
The information about a webhook subscription.
A webhook can either provide the resource_id
to subscribe to events generated by a specific resource,
or they can subscribe to the available events for all resources in the webhook's project when the resource_id
is omitted.
The information about an event type of a webhook subscription.
The information about a webhook delivery, such as the sent request, the received response, and how many times the webhook service retried to send the delivery in case of failure.
The information about the request made to deliver an event payload.
The payload that is delivered as the body of the request made to the webhook's destination URL.
Refers to the source of the event, for example hashicorp.packer.version
.
The event source type may differ from the resource that the webhook is subscribed to when the event is from a
descendent resource.
For example, webhooks subscribed to hashicorp.packer.registry
receive events for the descendant's resources,
such as a hashicorp.packer.version
.