Honeycomb

opencollection: 1.0.0
info:
  name: Honeycomb Triggers API
  version: 1.0.0
items:
- info:
    name: Recipients
    type: folder
  items:
  - info:
      name: List all Recipients
      type: http
    http:
      method: GET
      url: https://api.honeycomb.io/1/recipients
    docs: 'Retrieve all recipients for a team.

      '
  - info:
      name: Create a Recipient
      type: http
    http:
      method: POST
      url: https://api.honeycomb.io/1/recipients
      body:
        type: json
        data: '{}'
    docs: 'Unlike many resources, Recipients are not linked to a specific Environment or Dataset. The Recipient will be created
      for the Team associated with your API key.

      The `details` fields will vary depending on the `type` of Recipient. Use the drop-down to view the specific fields for
      each `type` value.

      Before Slack Recipients can be created, the Slack OAuth flow in the Integration Center must be completed.

      '
  - info:
      name: Get a single Recipient
      type: http
    http:
      method: GET
      url: https://api.honeycomb.io/1/recipients/:recipientId
      params:
      - name: recipientId
        value: ''
        type: path
        description: Unique identifier (ID) of a Recipient.
    docs: 'Retrieve a Recipient by recipient ID.

      '
  - info:
      name: Update a Recipient
      type: http
    http:
      method: PUT
      url: https://api.honeycomb.io/1/recipients/:recipientId
      params:
      - name: recipientId
        value: ''
        type: path
        description: Unique identifier (ID) of a Recipient.
      body:
        type: json
        data: '{}'
    docs: 'Update a Recipient by specifying the recipient ID and full recipient details. (Partial PUT is not supported.)

      Updates to the Recipient Type is not supported. For example, changing an existing Recipient from PagerDuty to Email
      is not allowed.

      **Important**: Modifying an existing recipient will change the destination of all triggers/burn alerts that use that
      recipient.

      '
  - info:
      name: Delete a Recipient
      type: http
    http:
      method: DELETE
      url: https://api.honeycomb.io/1/recipients/:recipientId
      params:
      - name: recipientId
        value: ''
        type: path
        description: Unique identifier (ID) of a Recipient.
    docs: 'Delete a recipient by specifying the recipient ID.

      A Recipient can only be deleted if it is NOT in use by any Triggers or Burn Alerts associated to the team.

      '
- info:
    name: Triggers
    type: folder
  items:
  - info:
      name: List All Triggers
      type: http
    http:
      method: GET
      url: https://api.honeycomb.io/1/triggers/:datasetSlug
      params:
      - name: datasetSlug
        value: ''
        type: path
        description: 'The dataset slug or use `__all__` for endpoints that support environment-wide operations.

          '
    docs: 'List all triggers on the provided dataset or environment.

      '
  - info:
      name: Create a Trigger
      type: http
    http:
      method: POST
      url: https://api.honeycomb.io/1/triggers/:datasetSlug
      params:
      - name: datasetSlug
        value: ''
        type: path
        description: 'The dataset slug or use `__all__` for endpoints that support environment-wide operations.

          '
      body:
        type: json
        data: '{}'
    docs: 'Create a trigger on the provided dataset or environment.

      '
  - info:
      name: Get a Trigger
      type: http
    http:
      method: GET
      url: https://api.honeycomb.io/1/triggers/:datasetSlug/:triggerId
      params:
      - name: datasetSlug
        value: ''
        type: path
        description: 'The dataset slug or use `__all__` for endpoints that support environment-wide operations.

          '
      - name: triggerId
        value: ''
        type: path
        description: The unique identifier (ID) of a Trigger.
    docs: 'Fetch details for a single Trigger by Trigger ID.

      '
  - info:
      name: Update a Trigger
      type: http
    http:
      method: PUT
      url: https://api.honeycomb.io/1/triggers/:datasetSlug/:triggerId
      params:
      - name: datasetSlug
        value: ''
        type: path
        description: 'The dataset slug or use `__all__` for endpoints that support environment-wide operations.

          '
      - name: triggerId
        value: ''
        type: path
        description: The unique identifier (ID) of a Trigger.
      body:
        type: json
        data: '{}'
    docs: 'Update a trigger by specifying the trigger ID and the same fields used when creating a new trigger.

      '
  - info:
      name: Delete a Trigger
      type: http
    http:
      method: DELETE
      url: https://api.honeycomb.io/1/triggers/:datasetSlug/:triggerId
      params:
      - name: datasetSlug
        value: ''
        type: path
        description: 'The dataset slug or use `__all__` for endpoints that support environment-wide operations.

          '
      - name: triggerId
        value: ''
        type: path
        description: The unique identifier (ID) of a Trigger.
    docs: 'Delete a trigger by specifying the trigger ID. The body of the DELETE request should be empty.

      '
  - info:
      name: Get Triggers Associated with a Recipient
      type: http
    http:
      method: GET
      url: https://api.honeycomb.io/1/recipients/:recipientId/triggers
      params:
      - name: recipientId
        value: ''
        type: path
        description: Unique identifier (ID) of a Recipient.
    docs: 'List all triggers that will alert a given Recipient. **Important:** This request will return all Triggers associated
      with the specific Recipient across your entire Honeycomb team rather than being scoped to a dataset or environment.

      '
bundled: true