{ "info": { "_postman_id": "acd2453b-2ffb-481c-a34a-e32fe1b7bd99", "name": "Spruce Health API \u2014 Webhooks", "description": "Webhooks operations of the Spruce Health API. Generated from the OpenAPI Spruce Health publishes for developer.sprucehealth.com.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "id": "fc6e1148-5aa7-404e-a3bf-2cd7e54074b6", "name": "Webhooks", "item": [ { "id": "004f7886-e620-45a0-880f-b136024a531a", "name": "List webhook destination endpoints", "request": { "name": "List webhook destination endpoints", "description": { "content": "This operation lists the endpoints that an organization has registered for webhooks.", "type": "text/plain" }, "method": "GET", "url": { "raw": "{{baseUrl}}/webhooks/endpoints", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", "endpoints" ], "query": [], "variable": [] }, "header": [ { "key": "Authorization", "value": "Bearer {{bearerToken}}" } ] }, "response": [] }, { "id": "137ae794-2b56-4513-9c40-9b508c273201", "name": "Create a webhook destination endpoint", "request": { "name": "Create a webhook destination endpoint", "description": { "content": "This operation creates a destination endpoint for webhooks events.", "type": "text/plain" }, "method": "POST", "url": { "raw": "{{baseUrl}}/webhooks/endpoints", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", "endpoints" ], "query": [], "variable": [] }, "header": [ { "key": "s-idempotency-key", "value": "", "description": "A unique value generated by the client used to recognize subsequent retries of the same request. Idempotency keys can be up to 255 characters long." }, { "key": "Authorization", "value": "Bearer {{bearerToken}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "81e9212d-e284-47fd-9f56-1832087e6592", "name": "Delete a webhook destination endpoint by id", "request": { "name": "Delete a webhook destination endpoint by id", "description": { "content": "This operation deleted a destination endpoint for webhook events by id.", "type": "text/plain" }, "method": "DELETE", "url": { "raw": "{{baseUrl}}/webhooks/endpoints/{endpointId}", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", "endpoints", "{endpointId}" ], "query": [], "variable": [ { "key": "endpointId", "value": "" } ] }, "header": [ { "key": "Authorization", "value": "Bearer {{bearerToken}}" } ] }, "response": [] }, { "id": "531d8256-7586-4cb6-9c3f-345d8db4340b", "name": "Get a webhook destination endpoint by id", "request": { "name": "Get a webhook destination endpoint by id", "description": { "content": "This operation retrieves a specific destination endpoint for webhooks events by id.", "type": "text/plain" }, "method": "GET", "url": { "raw": "{{baseUrl}}/webhooks/endpoints/{endpointId}", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", "endpoints", "{endpointId}" ], "query": [], "variable": [ { "key": "endpointId", "value": "" } ] }, "header": [ { "key": "Authorization", "value": "Bearer {{bearerToken}}" } ] }, "response": [] }, { "id": "a2c3da49-84d4-42c4-a6de-01a32e3343e4", "name": "List events for an endpoint", "request": { "name": "List events for an endpoint", "description": { "content": "This operation retrieves information about events that have been attempted to be published to a webhook destination endpoint. Events are queryable for a period of 30 days after creation and are returned in sets of 20 at a time. Use the pagination token to retrieve more events.", "type": "text/plain" }, "method": "GET", "url": { "raw": "{{baseUrl}}/webhooks/endpoints/{endpointId}/events", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", "endpoints", "{endpointId}", "events" ], "query": [ { "disabled": false, "key": "startTime", "value": "" }, { "disabled": false, "key": "endTime", "value": "" }, { "disabled": false, "key": "paginationToken", "value": "" } ], "variable": [ { "key": "endpointId", "value": "" } ] }, "header": [ { "key": "Authorization", "value": "Bearer {{bearerToken}}" } ] }, "response": [] }, { "id": "1222716e-2271-46c1-87d4-2ae69b10acdf", "name": "Pause or resume a webhook destination endpoint", "request": { "name": "Pause or resume a webhook destination endpoint", "description": { "content": "This operation sets the 'paused' state of a webhook destination endpoint.", "type": "text/plain" }, "method": "POST", "url": { "raw": "{{baseUrl}}/webhooks/endpoints/{endpointId}/paused", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", "endpoints", "{endpointId}", "paused" ], "query": [ { "disabled": false, "key": "paused", "value": "" } ], "variable": [ { "key": "endpointId", "value": "" } ] }, "header": [ { "key": "s-idempotency-key", "value": "", "description": "A unique value generated by the client used to recognize subsequent retries of the same request. Idempotency keys can be up to 255 characters long." }, { "key": "Authorization", "value": "Bearer {{bearerToken}}" } ] }, "response": [] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.sprucehealth.com/v1" } ] }