diff --git a/webhooks/webhooks_api.md b/webhooks/webhooks_api.md index db212f6..b193e6f 100644 --- a/webhooks/webhooks_api.md +++ b/webhooks/webhooks_api.md @@ -145,18 +145,18 @@ You can also use the `filter[status]` query parameter to specify whether you wan The following table describes the various attributes of the List Webhooks Deliveries response body. -| Response Attribute | Description | -|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| started_at | Start time in UTC for the webhooks event delivery. | -| response_status | Status code returned from the delivery attempt. For example, `200 OK`, `404 Not Found`, etc. Explanations of common status codes are provided in the [RESTful API Concepts]({{ site.url }}{{ site.baseurl }}{% link api_essentials/restful_api_concepts.md %}) guide. | -| response_headers | Object containing key/value pairs representing the HTTP header fields included in the response to the webhooks delivery POST call. | -| response_error | Error response message, if applicable. | -| response_body | Content of the HTTP response body resulting from the webhooks delivery POST call. | -| outcome | Result for the webhooks event delivery attempt. Can be one of 'ok', 'discarded', 'retried', or 'failed'. | -| id | Unique identifier for the delivery. | -| event_id | Unique identifier for the webhooks event for which a delivery was attempted. | -| event | The event object containing the following properties:
- _user_id_ - ID for the User that initiated the event.
- _timestamp_ - UTC date/time when the event occurred.
- _resource_name_ - Name of the Resource in which the event occurred.
- _resource_id_ - ID for the Resource in which the event occurred.
- _project_id_ - ID of the Project in which the event occurred.
- _id_ - ID for the event.
- _event_type_ - Type of event - will be 'create', 'update', or 'delete'.
- _company_id_ - ID of the Company in which the event occurred.
- _api_version_ - Procore API version.
- _metadata_ - An object containing contextual information about the event.
- _ulid_ - Unique identifier encoded as a 26 character string. See [ULID specification](https://github.com/ulid/spec) for additional information. | -| completed_at | Time in UTC when the webhooks event delivery completed. | +| Response Attribute | Type | Description | +|--------------------|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| started_at | string | Start time in UTC for the webhooks event delivery. | +| response_status | int32 | Status code returned from the delivery attempt. For example, 200 `OK`, 404 `Not Found`, etc. Explanations of common status codes are provided in the [RESTful API Concepts]({{ site.url }}{{ site.baseurl }}{% link api_essentials/restful_api_concepts.md %}) guide. | +| response_headers | object | Object containing key/value pairs representing the HTTP header fields included in the response to the webhooks delivery POST call. | +| response_error | string | Error response message, if applicable. | +| response_body | string | Content of the HTTP response body resulting from the webhooks delivery POST call. | +| outcome | string | Result for the webhooks event delivery attempt. Can be one of 'ok', 'discarded', 'retried', or 'failed'. | +| id | int64 | Unique identifier for the delivery. | +| event_id | int64 | Unique identifier for the webhooks event for which a delivery was attempted. | +| event | object | The event object containing the following properties:
- _user_id_ - ID for the User that initiated the event.
- _timestamp_ - UTC date/time when the event occurred.
- _resource_name_ - Name of the Resource in which the event occurred.
- _resource_id_ - ID for the Resource in which the event occurred.
- _project_id_ - ID of the Project in which the event occurred.
- _id_ - ID for the event.
- _event_type_ - Type of event - will be 'create', 'update', or 'delete'.
- _company_id_ - ID of the Company in which the event occurred.
- _api_version_ - Procore API version.
- _metadata_ - An object containing contextual information about the event.
- _ulid_ - Unique identifier encoded as a 26 character string. See [ULID specification](https://github.com/ulid/spec) for additional information. | +| completed_at | string | Time in UTC when the webhooks event delivery completed. | ### Filtering the List Webhooks Deliveries Response