HashiConf 2024 Now streaming live from Boston! Attend for free
HashiCorp Cloud Platform

HCP Webhook Service

Loading…
Status
(opens in new tab)
stable

API for delivering and managing webhooks.

Download Spec

Operations

​List​Webhooks

get

​/​webhook​/​{parent_resource_name}​/​webhooks

​List​Webhooks

https://api.cloud.hashicorp.com/2023-05-31/webhook/{parent_resource_name}/webhooks

Request

Path Parameters
parent_resource_namestringRequired

The parent resource of a webhook is an HCP project. A project's resource name format is project/<project-id>.

Query Parameters
pagination.page_sizeinteger

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.

pagination.next_page_tokenstring

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.

pagination.previous_page_tokenstring

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.

sorting.order_bystring[]

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.

Response

200 - OK
webhooksobject[]
  • resource_idstring

    Unique identifier for the platform.

  • resource_namestring

    The human-readable identifier for the platform. For example, webhooks/project/<project-id>/geo/<geography>/webhook/<webhook-name>.

  • descriptionstring

    The description of this webhook.

  • configobject

    The webhook configuration used to deliver event payloads.

    • hmac_keystring

      The optional HMAC key used to sign all requests.

    • urlstring

      The HTTP or HTTPS endpoint URL that HCP Packer delivers the requests to.

  • subscriptionsobject[]

    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.

    • resource_idstring

      Refers to the resource the webhook is subscribed to. If not set, the webhook subscribes to the emitted events listed in events for any resource in the webhook's project.

    • eventsobject[]

      The information about an event type of a webhook subscription.

      • actionstring

        The type of action of this event, such as create, update, or delete. When the action is '*', it means that the webhook is subscribed to all event actions for the event source.

      • sourcestring

        The source of the event, such as hashicorp.packer.version.

  • enabledboolean

    When true, this parameter indicates that the webhook is enabled and is able to receive payloads for the subscribed events.

  • last_deliveryobject

    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.

    • idstring

      The unique identifier for the delivery.

    • webhook_resource_idstring

      The ID of the webhook to which the payload was delivered.

    • requestobject

      The information about the request made to deliver an event payload.

      • headersobject

        The request headers.

      • urlstring

        The request's destination URL.

      • payloadobject

        The payload that is delivered as the body of the request made to the webhook's destination URL.

        • resource_idstring

          The ID of the resource the event is related to.

        • resource_namestring

          The name of the resource the event is related to.

        • event_idstring

          The unique identifier for the event generated by the services that own the resources. The value format is: <service>.event:<random string>, for example, packer.event:t79BRg8WhTmDPBRM.

        • event_actionstring

          The type of action performed by this event, for example create.

        • event_descriptionstring

          The event description, for example Created iteration.

        • event_sourcestring

          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.

        • event_versionstring

          The version of the payload being sent.

        • event_payloadobject

          The payload containing information about the resource's lifecycle event. The lifecycle event is defined by the services that own the resources.

      • sent_atstring

        The UTC time the request was sent.

    • responseobject

      The information about the response received after delivering an event payload.

      • status_codeinteger

        The response status code.

      • headersobject

        The response headers.

      • bodystring

        The response body.

    • retriesinteger

      The number of times HCP Packer resent the request before successfully delivering the payload.

  • created_atstring

    The time the webhook was created.

  • updated_atstring

    The time the webhook was last updated.

paginationobject

PaginationResponse is the response holding the page tokens for a paginated list response.

  • next_page_tokenstring

    This token allows you to get the next page of results for list requests. If the number of results is larger than page_size, use the next_page_token as a value for the query parameter next_page_token in the next request. The value will become empty when there are no more pages.

  • previous_page_tokenstring

    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.

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Create​Webhook

post

​/​webhook​/​{parent_resource_name}​/​webhooks

​Create​Webhook

https://api.cloud.hashicorp.com/2023-05-31/webhook/{parent_resource_name}/webhooks

Request

Path Parameters
parent_resource_namestringRequired

The parent resource of a webhook is an HCP project. A project's resource name format is project/<project-id>.

Body Parameters
namestring

The webhook name.

descriptionstring

The webhook description. Useful for providing a summary of the webhook.

configobject

The webhook configuration used to deliver event payloads.

  • hmac_keystring

    The optional HMAC key used to sign all requests.

  • urlstring

    The HTTP or HTTPS endpoint URL that HCP Packer delivers the requests to.

subscriptionsobject[]

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.

  • resource_idstring

    Refers to the resource the webhook is subscribed to. If not set, the webhook subscribes to the emitted events listed in events for any resource in the webhook's project.

  • eventsobject[]

    The information about an event type of a webhook subscription.

    • actionstring

      The type of action of this event, such as create, update, or delete. When the action is '*', it means that the webhook is subscribed to all event actions for the event source.

    • sourcestring

      The source of the event, such as hashicorp.packer.version.

test_payloadobject

The payload that is delivered as the body of the request made to the webhook's destination URL.

  • resource_idstring

    The ID of the resource the event is related to.

  • resource_namestring

    The name of the resource the event is related to.

  • event_idstring

    The unique identifier for the event generated by the services that own the resources. The value format is: <service>.event:<random string>, for example, packer.event:t79BRg8WhTmDPBRM.

  • event_actionstring

    The type of action performed by this event, for example create.

  • event_descriptionstring

    The event description, for example Created iteration.

  • event_sourcestring

    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.

  • event_versionstring

    The version of the payload being sent.

  • event_payloadobject

    The payload containing information about the resource's lifecycle event. The lifecycle event is defined by the services that own the resources.

enabledboolean

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.

Response

200 - OK
webhookobject
  • resource_idstring

    Unique identifier for the platform.

  • resource_namestring

    The human-readable identifier for the platform. For example, webhooks/project/<project-id>/geo/<geography>/webhook/<webhook-name>.

  • descriptionstring

    The description of this webhook.

  • configobject

    The webhook configuration used to deliver event payloads.

    • hmac_keystring

      The optional HMAC key used to sign all requests.

    • urlstring

      The HTTP or HTTPS endpoint URL that HCP Packer delivers the requests to.

  • subscriptionsobject[]

    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.

    • resource_idstring

      Refers to the resource the webhook is subscribed to. If not set, the webhook subscribes to the emitted events listed in events for any resource in the webhook's project.

    • eventsobject[]

      The information about an event type of a webhook subscription.

      • actionstring

        The type of action of this event, such as create, update, or delete. When the action is '*', it means that the webhook is subscribed to all event actions for the event source.

      • sourcestring

        The source of the event, such as hashicorp.packer.version.

  • enabledboolean

    When true, this parameter indicates that the webhook is enabled and is able to receive payloads for the subscribed events.

  • last_deliveryobject

    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.

    • idstring

      The unique identifier for the delivery.

    • webhook_resource_idstring

      The ID of the webhook to which the payload was delivered.

    • requestobject

      The information about the request made to deliver an event payload.

      • headersobject

        The request headers.

      • urlstring

        The request's destination URL.

      • payloadobject

        The payload that is delivered as the body of the request made to the webhook's destination URL.

        • resource_idstring

          The ID of the resource the event is related to.

        • resource_namestring

          The name of the resource the event is related to.

        • event_idstring

          The unique identifier for the event generated by the services that own the resources. The value format is: <service>.event:<random string>, for example, packer.event:t79BRg8WhTmDPBRM.

        • event_actionstring

          The type of action performed by this event, for example create.

        • event_descriptionstring

          The event description, for example Created iteration.

        • event_sourcestring

          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.

        • event_versionstring

          The version of the payload being sent.

        • event_payloadobject

          The payload containing information about the resource's lifecycle event. The lifecycle event is defined by the services that own the resources.

      • sent_atstring

        The UTC time the request was sent.

    • responseobject

      The information about the response received after delivering an event payload.

      • status_codeinteger

        The response status code.

      • headersobject

        The response headers.

      • bodystring

        The response body.

    • retriesinteger

      The number of times HCP Packer resent the request before successfully delivering the payload.

  • created_atstring

    The time the webhook was created.

  • updated_atstring

    The time the webhook was last updated.

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​List​Webhook​Deliveries

get

​/​{parent_resource_name}​/​deliveries

​List​Webhook​Deliveries

https://api.cloud.hashicorp.com/2023-05-31/{parent_resource_name}/deliveries

Request

Path Parameters
parent_resource_namestringRequired

The parent resource of webhook deliveries is a webhook. A webhook's resource name format name is webhook/project/<project-id>/geo/<geography>/webhook/<webhook-name>.

Query Parameters
pagination.page_sizeinteger

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.

pagination.next_page_tokenstring

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.

pagination.previous_page_tokenstring

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.

sorting.order_bystring[]

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.

Response

200 - OK
deliveriesobject[]

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.

  • idstring

    The unique identifier for the delivery.

  • webhook_resource_idstring

    The ID of the webhook to which the payload was delivered.

  • requestobject

    The information about the request made to deliver an event payload.

    • headersobject

      The request headers.

    • urlstring

      The request's destination URL.

    • payloadobject

      The payload that is delivered as the body of the request made to the webhook's destination URL.

      • resource_idstring

        The ID of the resource the event is related to.

      • resource_namestring

        The name of the resource the event is related to.

      • event_idstring

        The unique identifier for the event generated by the services that own the resources. The value format is: <service>.event:<random string>, for example, packer.event:t79BRg8WhTmDPBRM.

      • event_actionstring

        The type of action performed by this event, for example create.

      • event_descriptionstring

        The event description, for example Created iteration.

      • event_sourcestring

        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.

      • event_versionstring

        The version of the payload being sent.

      • event_payloadobject

        The payload containing information about the resource's lifecycle event. The lifecycle event is defined by the services that own the resources.

    • sent_atstring

      The UTC time the request was sent.

  • responseobject

    The information about the response received after delivering an event payload.

    • status_codeinteger

      The response status code.

    • headersobject

      The response headers.

    • bodystring

      The response body.

  • retriesinteger

    The number of times HCP Packer resent the request before successfully delivering the payload.

paginationobject

PaginationResponse is the response holding the page tokens for a paginated list response.

  • next_page_tokenstring

    This token allows you to get the next page of results for list requests. If the number of results is larger than page_size, use the next_page_token as a value for the query parameter next_page_token in the next request. The value will become empty when there are no more pages.

  • previous_page_tokenstring

    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.

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Get​Webhook

get

​/​{resource_name}

​Get​Webhook

https://api.cloud.hashicorp.com/2023-05-31/{resource_name}

Request

Path Parameters
resource_namestringRequired

The webhook resource name. A webhook's resource name format name is webhook/project/<project-id>/geo/<geography>/webhook/<webhook-name>.

Response

200 - OK
webhookobject
  • resource_idstring

    Unique identifier for the platform.

  • resource_namestring

    The human-readable identifier for the platform. For example, webhooks/project/<project-id>/geo/<geography>/webhook/<webhook-name>.

  • descriptionstring

    The description of this webhook.

  • configobject

    The webhook configuration used to deliver event payloads.

    • hmac_keystring

      The optional HMAC key used to sign all requests.

    • urlstring

      The HTTP or HTTPS endpoint URL that HCP Packer delivers the requests to.

  • subscriptionsobject[]

    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.

    • resource_idstring

      Refers to the resource the webhook is subscribed to. If not set, the webhook subscribes to the emitted events listed in events for any resource in the webhook's project.

    • eventsobject[]

      The information about an event type of a webhook subscription.

      • actionstring

        The type of action of this event, such as create, update, or delete. When the action is '*', it means that the webhook is subscribed to all event actions for the event source.

      • sourcestring

        The source of the event, such as hashicorp.packer.version.

  • enabledboolean

    When true, this parameter indicates that the webhook is enabled and is able to receive payloads for the subscribed events.

  • last_deliveryobject

    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.

    • idstring

      The unique identifier for the delivery.

    • webhook_resource_idstring

      The ID of the webhook to which the payload was delivered.

    • requestobject

      The information about the request made to deliver an event payload.

      • headersobject

        The request headers.

      • urlstring

        The request's destination URL.

      • payloadobject

        The payload that is delivered as the body of the request made to the webhook's destination URL.

        • resource_idstring

          The ID of the resource the event is related to.

        • resource_namestring

          The name of the resource the event is related to.

        • event_idstring

          The unique identifier for the event generated by the services that own the resources. The value format is: <service>.event:<random string>, for example, packer.event:t79BRg8WhTmDPBRM.

        • event_actionstring

          The type of action performed by this event, for example create.

        • event_descriptionstring

          The event description, for example Created iteration.

        • event_sourcestring

          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.

        • event_versionstring

          The version of the payload being sent.

        • event_payloadobject

          The payload containing information about the resource's lifecycle event. The lifecycle event is defined by the services that own the resources.

      • sent_atstring

        The UTC time the request was sent.

    • responseobject

      The information about the response received after delivering an event payload.

      • status_codeinteger

        The response status code.

      • headersobject

        The response headers.

      • bodystring

        The response body.

    • retriesinteger

      The number of times HCP Packer resent the request before successfully delivering the payload.

  • created_atstring

    The time the webhook was created.

  • updated_atstring

    The time the webhook was last updated.

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Delete​Webhook

delete

​/​{resource_name}

​Delete​Webhook

https://api.cloud.hashicorp.com/2023-05-31/{resource_name}

Request

Path Parameters
resource_namestringRequired

The webhook resource name. A webhook's resource name format name is webhook/project/<project-id>/geo/<geography>/webhook/<webhook-name>.

Response

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Update​Webhook

patch

​/​{resource_name}

​Update​Webhook

https://api.cloud.hashicorp.com/2023-05-31/{resource_name}

Request

Path Parameters
resource_namestringRequired

The webhook resource name. A webhook's resource name format name is webhook/project/<project-id>/geo/<geography>/webhook/<webhook-name>.

Body Parameters
webhookobject
  • resource_idstring

    Unique identifier for the platform.

  • resource_namestring

    The human-readable identifier for the platform. For example, webhooks/project/<project-id>/geo/<geography>/webhook/<webhook-name>.

  • descriptionstring

    The description of this webhook.

  • configobject

    The webhook configuration used to deliver event payloads.

    • hmac_keystring

      The optional HMAC key used to sign all requests.

    • urlstring

      The HTTP or HTTPS endpoint URL that HCP Packer delivers the requests to.

  • subscriptionsobject[]

    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.

    • resource_idstring

      Refers to the resource the webhook is subscribed to. If not set, the webhook subscribes to the emitted events listed in events for any resource in the webhook's project.

    • eventsobject[]

      The information about an event type of a webhook subscription.

      • actionstring

        The type of action of this event, such as create, update, or delete. When the action is '*', it means that the webhook is subscribed to all event actions for the event source.

      • sourcestring

        The source of the event, such as hashicorp.packer.version.

  • enabledboolean

    When true, this parameter indicates that the webhook is enabled and is able to receive payloads for the subscribed events.

  • last_deliveryobject

    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.

    • idstring

      The unique identifier for the delivery.

    • webhook_resource_idstring

      The ID of the webhook to which the payload was delivered.

    • requestobject

      The information about the request made to deliver an event payload.

      • headersobject

        The request headers.

      • urlstring

        The request's destination URL.

      • payloadobject

        The payload that is delivered as the body of the request made to the webhook's destination URL.

        • resource_idstring

          The ID of the resource the event is related to.

        • resource_namestring

          The name of the resource the event is related to.

        • event_idstring

          The unique identifier for the event generated by the services that own the resources. The value format is: <service>.event:<random string>, for example, packer.event:t79BRg8WhTmDPBRM.

        • event_actionstring

          The type of action performed by this event, for example create.

        • event_descriptionstring

          The event description, for example Created iteration.

        • event_sourcestring

          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.

        • event_versionstring

          The version of the payload being sent.

        • event_payloadobject

          The payload containing information about the resource's lifecycle event. The lifecycle event is defined by the services that own the resources.

      • sent_atstring

        The UTC time the request was sent.

    • responseobject

      The information about the response received after delivering an event payload.

      • status_codeinteger

        The response status code.

      • headersobject

        The response headers.

      • bodystring

        The response body.

    • retriesinteger

      The number of times HCP Packer resent the request before successfully delivering the payload.

  • created_atstring

    The time the webhook was created.

  • updated_atstring

    The time the webhook was last updated.

update_maskstring

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.
test_payloadobject

The payload that is delivered as the body of the request made to the webhook's destination URL.

  • resource_idstring

    The ID of the resource the event is related to.

  • resource_namestring

    The name of the resource the event is related to.

  • event_idstring

    The unique identifier for the event generated by the services that own the resources. The value format is: <service>.event:<random string>, for example, packer.event:t79BRg8WhTmDPBRM.

  • event_actionstring

    The type of action performed by this event, for example create.

  • event_descriptionstring

    The event description, for example Created iteration.

  • event_sourcestring

    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.

  • event_versionstring

    The version of the payload being sent.

  • event_payloadobject

    The payload containing information about the resource's lifecycle event. The lifecycle event is defined by the services that own the resources.

Response

200 - OK
webhookobject
  • resource_idstring

    Unique identifier for the platform.

  • resource_namestring

    The human-readable identifier for the platform. For example, webhooks/project/<project-id>/geo/<geography>/webhook/<webhook-name>.

  • descriptionstring

    The description of this webhook.

  • configobject

    The webhook configuration used to deliver event payloads.

    • hmac_keystring

      The optional HMAC key used to sign all requests.

    • urlstring

      The HTTP or HTTPS endpoint URL that HCP Packer delivers the requests to.

  • subscriptionsobject[]

    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.

    • resource_idstring

      Refers to the resource the webhook is subscribed to. If not set, the webhook subscribes to the emitted events listed in events for any resource in the webhook's project.

    • eventsobject[]

      The information about an event type of a webhook subscription.

      • actionstring

        The type of action of this event, such as create, update, or delete. When the action is '*', it means that the webhook is subscribed to all event actions for the event source.

      • sourcestring

        The source of the event, such as hashicorp.packer.version.

  • enabledboolean

    When true, this parameter indicates that the webhook is enabled and is able to receive payloads for the subscribed events.

  • last_deliveryobject

    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.

    • idstring

      The unique identifier for the delivery.

    • webhook_resource_idstring

      The ID of the webhook to which the payload was delivered.

    • requestobject

      The information about the request made to deliver an event payload.

      • headersobject

        The request headers.

      • urlstring

        The request's destination URL.

      • payloadobject

        The payload that is delivered as the body of the request made to the webhook's destination URL.

        • resource_idstring

          The ID of the resource the event is related to.

        • resource_namestring

          The name of the resource the event is related to.

        • event_idstring

          The unique identifier for the event generated by the services that own the resources. The value format is: <service>.event:<random string>, for example, packer.event:t79BRg8WhTmDPBRM.

        • event_actionstring

          The type of action performed by this event, for example create.

        • event_descriptionstring

          The event description, for example Created iteration.

        • event_sourcestring

          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.

        • event_versionstring

          The version of the payload being sent.

        • event_payloadobject

          The payload containing information about the resource's lifecycle event. The lifecycle event is defined by the services that own the resources.

      • sent_atstring

        The UTC time the request was sent.

    • responseobject

      The information about the response received after delivering an event payload.

      • status_codeinteger

        The response status code.

      • headersobject

        The response headers.

      • bodystring

        The response body.

    • retriesinteger

      The number of times HCP Packer resent the request before successfully delivering the payload.

  • created_atstring

    The time the webhook was created.

  • updated_atstring

    The time the webhook was last updated.

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring

​Update​Webhook​Name

patch

​/​{resource_name}​/​name

​Update​Webhook​Name

https://api.cloud.hashicorp.com/2023-05-31/{resource_name}/name

Request

Path Parameters
resource_namestringRequired

The webhook resource name. A webhook's resource name format name is webhook/project/<project-id>/geo/<geography>/webhook/<webhook-name>.

Body Parameters
namestring

The updated name for the webhook.

Response

200 - OK
webhookobject
  • resource_idstring

    Unique identifier for the platform.

  • resource_namestring

    The human-readable identifier for the platform. For example, webhooks/project/<project-id>/geo/<geography>/webhook/<webhook-name>.

  • descriptionstring

    The description of this webhook.

  • configobject

    The webhook configuration used to deliver event payloads.

    • hmac_keystring

      The optional HMAC key used to sign all requests.

    • urlstring

      The HTTP or HTTPS endpoint URL that HCP Packer delivers the requests to.

  • subscriptionsobject[]

    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.

    • resource_idstring

      Refers to the resource the webhook is subscribed to. If not set, the webhook subscribes to the emitted events listed in events for any resource in the webhook's project.

    • eventsobject[]

      The information about an event type of a webhook subscription.

      • actionstring

        The type of action of this event, such as create, update, or delete. When the action is '*', it means that the webhook is subscribed to all event actions for the event source.

      • sourcestring

        The source of the event, such as hashicorp.packer.version.

  • enabledboolean

    When true, this parameter indicates that the webhook is enabled and is able to receive payloads for the subscribed events.

  • last_deliveryobject

    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.

    • idstring

      The unique identifier for the delivery.

    • webhook_resource_idstring

      The ID of the webhook to which the payload was delivered.

    • requestobject

      The information about the request made to deliver an event payload.

      • headersobject

        The request headers.

      • urlstring

        The request's destination URL.

      • payloadobject

        The payload that is delivered as the body of the request made to the webhook's destination URL.

        • resource_idstring

          The ID of the resource the event is related to.

        • resource_namestring

          The name of the resource the event is related to.

        • event_idstring

          The unique identifier for the event generated by the services that own the resources. The value format is: <service>.event:<random string>, for example, packer.event:t79BRg8WhTmDPBRM.

        • event_actionstring

          The type of action performed by this event, for example create.

        • event_descriptionstring

          The event description, for example Created iteration.

        • event_sourcestring

          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.

        • event_versionstring

          The version of the payload being sent.

        • event_payloadobject

          The payload containing information about the resource's lifecycle event. The lifecycle event is defined by the services that own the resources.

      • sent_atstring

        The UTC time the request was sent.

    • responseobject

      The information about the response received after delivering an event payload.

      • status_codeinteger

        The response status code.

      • headersobject

        The response headers.

      • bodystring

        The response body.

    • retriesinteger

      The number of times HCP Packer resent the request before successfully delivering the payload.

  • created_atstring

    The time the webhook was created.

  • updated_atstring

    The time the webhook was last updated.

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring