{ "opencollection": "1.0.0", "info": { "name": "HighBond API Reference Actions Events API", "version": "1.1.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Events", "type": "folder" }, "items": [ { "info": { "name": "List Events", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{server}/v1/orgs/:org_id/events", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "The ID of the HighBond instance." } ] }, "docs": "List Events and their metadata for an organization. Does not include associated workflow statuses or handlers." }, { "info": { "name": "Create an event", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{server}/v1/orgs/:org_id/events", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "The ID of the HighBond instance." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new event in a org." }, { "info": { "name": "Get an event", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{server}/v1/orgs/:org_id/events/:id", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "The ID of the HighBond instance." }, { "name": "id", "value": "", "type": "path", "description": "The ID of the requested resource." }, { "name": "include", "value": "statuses,handlers", "type": "query", "description": "If specified, the event's associated statuses and/or handlers will be included in the `included` object" } ] }, "docs": "Get information about an event." }, { "info": { "name": "Update an event", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{server}/v1/orgs/:org_id/events/:id", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "The ID of the HighBond instance." }, { "name": "id", "value": "", "type": "path", "description": "The ID of the requested resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Make changes to metadata for an existing event, such as changing the admin_name or the description." }, { "info": { "name": "Delete an Event", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{server}/v1/orgs/:org_id/events/:id", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "The ID of the HighBond instance." }, { "name": "id", "value": "", "type": "path", "description": "The ID of the requested resource." } ] }, "docs": "Permanently delete an event.\n" } ] } ], "bundled": true }