1. Packages
  2. Honeycombio Provider
  3. API Docs
  4. getRecipient
Honeycomb 0.42.0 published on Friday, Oct 10, 2025 by honeycombio
honeycombio/terraform-provider-honeycombio

honeycombio.getRecipient

Start a Neo task
Explain and create a honeycombio.getRecipient resource
honeycombio logo
Honeycomb 0.42.0 published on Friday, Oct 10, 2025 by honeycombio
honeycombio/terraform-provider-honeycombio

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as honeycombio from "@pulumi/honeycombio";

const slack = honeycombio.getRecipient({
    type: "slack",
    detailFilter: {
        name: "channel",
        value: "#honeycomb-triggers",
    },
});
const exampleQuerySpecification = honeycombio.getQuerySpecification({
    calculations: [{
        op: "AVG",
        column: "duration_ms",
    }],
});
const exampleTrigger = new honeycombio.Trigger("exampleTrigger", {
    queryJson: exampleQuerySpecification.then(exampleQuerySpecification => exampleQuerySpecification.json),
    dataset: _var.dataset,
    thresholds: [{
        op: ">",
        value: 1000,
    }],
    recipients: [
        {
            type: "email",
            target: "hello@example.com",
        },
        {
            id: slack.then(slack => slack.id),
        },
    ],
});

    import pulumi
import pulumi_honeycombio as honeycombio

slack = honeycombio.get_recipient(type="slack",
    detail_filter={
        "name": "channel",
        "value": "#honeycomb-triggers",
    })
example_query_specification = honeycombio.get_query_specification(calculations=[{
    "op": "AVG",
    "column": "duration_ms",
}])
example_trigger = honeycombio.Trigger("exampleTrigger",
    query_json=example_query_specification.json,
    dataset=var["dataset"],
    thresholds=[{
        "op": ">",
        "value": 1000,
    }],
    recipients=[
        {
            "type": "email",
            "target": "hello@example.com",
        },
        {
            "id": slack.id,
        },
    ])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/honeycombio/honeycombio"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		slack, err := honeycombio.GetRecipient(ctx, &honeycombio.GetRecipientArgs{
			Type: "slack",
			DetailFilter: honeycombio.GetRecipientDetailFilter{
				Name:  "channel",
				Value: pulumi.StringRef("#honeycomb-triggers"),
			},
		}, nil)
		if err != nil {
			return err
		}
		exampleQuerySpecification, err := honeycombio.GetQuerySpecification(ctx, &honeycombio.GetQuerySpecificationArgs{
			Calculations: []honeycombio.GetQuerySpecificationCalculation{
				{
					Op:     "AVG",
					Column: pulumi.StringRef("duration_ms"),
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		_, err = honeycombio.NewTrigger(ctx, "exampleTrigger", &honeycombio.TriggerArgs{
			QueryJson: pulumi.String(exampleQuerySpecification.Json),
			Dataset:   pulumi.Any(_var.Dataset),
			Thresholds: honeycombio.TriggerThresholdArray{
				&honeycombio.TriggerThresholdArgs{
					Op:    pulumi.String(">"),
					Value: pulumi.Float64(1000),
				},
			},
			Recipients: honeycombio.TriggerRecipientArray{
				&honeycombio.TriggerRecipientArgs{
					Type:   pulumi.String("email"),
					Target: pulumi.String("hello@example.com"),
				},
				&honeycombio.TriggerRecipientArgs{
					Id: pulumi.String(slack.Id),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Honeycombio = Pulumi.Honeycombio;

return await Deployment.RunAsync(() => 
{
    var slack = Honeycombio.GetRecipient.Invoke(new()
    {
        Type = "slack",
        DetailFilter = new Honeycombio.Inputs.GetRecipientDetailFilterInputArgs
        {
            Name = "channel",
            Value = "#honeycomb-triggers",
        },
    });

    var exampleQuerySpecification = Honeycombio.GetQuerySpecification.Invoke(new()
    {
        Calculations = new[]
        {
            new Honeycombio.Inputs.GetQuerySpecificationCalculationInputArgs
            {
                Op = "AVG",
                Column = "duration_ms",
            },
        },
    });

    var exampleTrigger = new Honeycombio.Trigger("exampleTrigger", new()
    {
        QueryJson = exampleQuerySpecification.Apply(getQuerySpecificationResult => getQuerySpecificationResult.Json),
        Dataset = @var.Dataset,
        Thresholds = new[]
        {
            new Honeycombio.Inputs.TriggerThresholdArgs
            {
                Op = ">",
                Value = 1000,
            },
        },
        Recipients = new[]
        {
            new Honeycombio.Inputs.TriggerRecipientArgs
            {
                Type = "email",
                Target = "hello@example.com",
            },
            new Honeycombio.Inputs.TriggerRecipientArgs
            {
                Id = slack.Apply(getRecipientResult => getRecipientResult.Id),
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.honeycombio.HoneycombioFunctions;
import com.pulumi.honeycombio.inputs.GetRecipientArgs;
import com.pulumi.honeycombio.inputs.GetRecipientDetailFilterArgs;
import com.pulumi.honeycombio.inputs.GetQuerySpecificationArgs;
import com.pulumi.honeycombio.Trigger;
import com.pulumi.honeycombio.TriggerArgs;
import com.pulumi.honeycombio.inputs.TriggerThresholdArgs;
import com.pulumi.honeycombio.inputs.TriggerRecipientArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var slack = HoneycombioFunctions.getRecipient(GetRecipientArgs.builder()
            .type("slack")
            .detailFilter(GetRecipientDetailFilterArgs.builder()
                .name("channel")
                .value("#honeycomb-triggers")
                .build())
            .build());

        final var exampleQuerySpecification = HoneycombioFunctions.getQuerySpecification(GetQuerySpecificationArgs.builder()
            .calculations(GetQuerySpecificationCalculationArgs.builder()
                .op("AVG")
                .column("duration_ms")
                .build())
            .build());

        var exampleTrigger = new Trigger("exampleTrigger", TriggerArgs.builder()
            .queryJson(exampleQuerySpecification.applyValue(getQuerySpecificationResult -> getQuerySpecificationResult.json()))
            .dataset(var_.dataset())
            .thresholds(TriggerThresholdArgs.builder()
                .op(">")
                .value(1000)
                .build())
            .recipients(            
                TriggerRecipientArgs.builder()
                    .type("email")
                    .target("hello@example.com")
                    .build(),
                TriggerRecipientArgs.builder()
                    .id(slack.applyValue(getRecipientResult -> getRecipientResult.id()))
                    .build())
            .build());

    }
}

    resources:
  exampleTrigger:
    type: honeycombio:Trigger
    properties:
      queryJson: ${exampleQuerySpecification.json}
      dataset: ${var.dataset}
      thresholds:
        - op: '>'
          value: 1000
      recipients:
        - type: email
          target: hello@example.com
        - id: ${slack.id}
variables:
  slack:
    fn::invoke:
      function: honeycombio:getRecipient
      arguments:
        type: slack
        detailFilter:
          name: channel
          value: '#honeycomb-triggers'
  exampleQuerySpecification:
    fn::invoke:
      function: honeycombio:getQuerySpecification
      arguments:
        calculations:
          - op: AVG
            column: duration_ms

    Using getRecipient

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRecipient(args: GetRecipientArgs, opts?: InvokeOptions): Promise<GetRecipientResult>
function getRecipientOutput(args: GetRecipientOutputArgs, opts?: InvokeOptions): Output<GetRecipientResult>
    def get_recipient(dataset: Optional[str] = None,
                  detail_filter: Optional[GetRecipientDetailFilter] = None,
                  id: Optional[str] = None,
                  target: Optional[str] = None,
                  type: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetRecipientResult
def get_recipient_output(dataset: Optional[pulumi.Input[str]] = None,
                  detail_filter: Optional[pulumi.Input[GetRecipientDetailFilterArgs]] = None,
                  id: Optional[pulumi.Input[str]] = None,
                  target: Optional[pulumi.Input[str]] = None,
                  type: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetRecipientResult]
    func GetRecipient(ctx *Context, args *GetRecipientArgs, opts ...InvokeOption) (*GetRecipientResult, error)
func GetRecipientOutput(ctx *Context, args *GetRecipientOutputArgs, opts ...InvokeOption) GetRecipientResultOutput

    > Note: This function is named GetRecipient in the Go SDK.

    public static class GetRecipient 
{
    public static Task<GetRecipientResult> InvokeAsync(GetRecipientArgs args, InvokeOptions? opts = null)
    public static Output<GetRecipientResult> Invoke(GetRecipientInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRecipientResult> getRecipient(GetRecipientArgs args, InvokeOptions options)
public static Output<GetRecipientResult> getRecipient(GetRecipientArgs args, InvokeOptions options)

    fn::invoke:
  function: honeycombio:index/getRecipient:getRecipient
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Type string
    The type of recipient, allowed types are email, pagerduty, msteams, msteams_workflow, slack and webhook.
    Dataset string
    Deprecated: recipients are now a Team-level construct. Any provided value will be ignored.

    Deprecated: Deprecated

    DetailFilter GetRecipientDetailFilter
    a block to further filter recipients as described below.
    Id string
    ID of the recipient.
    Target string

    Deprecated: use detail_filter instead. The target of the recipient, this has another meaning depending on the type of recipient (see the table below).

    Type | Target -----------------|------------------------- email | an email address marker | name of the marker msteams | name of the integration msteams_workflow | name of the integration pagerduty | N/A slack | name of the channel webhook | name of the webhook

    Deprecated: Deprecated

    Type string
    The type of recipient, allowed types are email, pagerduty, msteams, msteams_workflow, slack and webhook.
    Dataset string
    Deprecated: recipients are now a Team-level construct. Any provided value will be ignored.

    Deprecated: Deprecated

    DetailFilter GetRecipientDetailFilter
    a block to further filter recipients as described below.
    Id string
    ID of the recipient.
    Target string

    Deprecated: use detail_filter instead. The target of the recipient, this has another meaning depending on the type of recipient (see the table below).

    Type | Target -----------------|------------------------- email | an email address marker | name of the marker msteams | name of the integration msteams_workflow | name of the integration pagerduty | N/A slack | name of the channel webhook | name of the webhook

    Deprecated: Deprecated

    type String
    The type of recipient, allowed types are email, pagerduty, msteams, msteams_workflow, slack and webhook.
    dataset String
    Deprecated: recipients are now a Team-level construct. Any provided value will be ignored.

    Deprecated: Deprecated

    detailFilter GetRecipientDetailFilter
    a block to further filter recipients as described below.
    id String
    ID of the recipient.
    target String

    Deprecated: use detail_filter instead. The target of the recipient, this has another meaning depending on the type of recipient (see the table below).

    Type | Target -----------------|------------------------- email | an email address marker | name of the marker msteams | name of the integration msteams_workflow | name of the integration pagerduty | N/A slack | name of the channel webhook | name of the webhook

    Deprecated: Deprecated

    type string
    The type of recipient, allowed types are email, pagerduty, msteams, msteams_workflow, slack and webhook.
    dataset string
    Deprecated: recipients are now a Team-level construct. Any provided value will be ignored.

    Deprecated: Deprecated

    detailFilter GetRecipientDetailFilter
    a block to further filter recipients as described below.
    id string
    ID of the recipient.
    target string

    Deprecated: use detail_filter instead. The target of the recipient, this has another meaning depending on the type of recipient (see the table below).

    Type | Target -----------------|------------------------- email | an email address marker | name of the marker msteams | name of the integration msteams_workflow | name of the integration pagerduty | N/A slack | name of the channel webhook | name of the webhook

    Deprecated: Deprecated

    type str
    The type of recipient, allowed types are email, pagerduty, msteams, msteams_workflow, slack and webhook.
    dataset str
    Deprecated: recipients are now a Team-level construct. Any provided value will be ignored.

    Deprecated: Deprecated

    detail_filter GetRecipientDetailFilter
    a block to further filter recipients as described below.
    id str
    ID of the recipient.
    target str

    Deprecated: use detail_filter instead. The target of the recipient, this has another meaning depending on the type of recipient (see the table below).

    Type | Target -----------------|------------------------- email | an email address marker | name of the marker msteams | name of the integration msteams_workflow | name of the integration pagerduty | N/A slack | name of the channel webhook | name of the webhook

    Deprecated: Deprecated

    type String
    The type of recipient, allowed types are email, pagerduty, msteams, msteams_workflow, slack and webhook.
    dataset String
    Deprecated: recipients are now a Team-level construct. Any provided value will be ignored.

    Deprecated: Deprecated

    detailFilter Property Map
    a block to further filter recipients as described below.
    id String
    ID of the recipient.
    target String

    Deprecated: use detail_filter instead. The target of the recipient, this has another meaning depending on the type of recipient (see the table below).

    Type | Target -----------------|------------------------- email | an email address marker | name of the marker msteams | name of the integration msteams_workflow | name of the integration pagerduty | N/A slack | name of the channel webhook | name of the webhook

    Deprecated: Deprecated

    getRecipient Result

    The following output properties are available:

    Address string
    The email recipient's address -- if of type email.
    Channel string
    The Slack recipient's channel -- if of type slack.
    Id string
    ID of the recipient.
    IntegrationKey string
    (Sensitive) The PagerDuty recipient's integration key -- if of type pagerduty.
    IntegrationName string
    The PagerDuty recipient's integration name -- if of type pagerduty.
    Name string
    The webhook recipient's name -- if of type webhook or msteams.
    Secret string
    (Sensitive) The webhook recipient's secret -- if of type webhook.
    Type string
    Url string
    The webhook recipient's URL - if of type webhook, msteams or msteams_workflow.
    Dataset string

    Deprecated: Deprecated

    DetailFilter GetRecipientDetailFilter
    Target string

    Deprecated: Deprecated

    Address string
    The email recipient's address -- if of type email.
    Channel string
    The Slack recipient's channel -- if of type slack.
    Id string
    ID of the recipient.
    IntegrationKey string
    (Sensitive) The PagerDuty recipient's integration key -- if of type pagerduty.
    IntegrationName string
    The PagerDuty recipient's integration name -- if of type pagerduty.
    Name string
    The webhook recipient's name -- if of type webhook or msteams.
    Secret string
    (Sensitive) The webhook recipient's secret -- if of type webhook.
    Type string
    Url string
    The webhook recipient's URL - if of type webhook, msteams or msteams_workflow.
    Dataset string

    Deprecated: Deprecated

    DetailFilter GetRecipientDetailFilter
    Target string

    Deprecated: Deprecated

    address String
    The email recipient's address -- if of type email.
    channel String
    The Slack recipient's channel -- if of type slack.
    id String
    ID of the recipient.
    integrationKey String
    (Sensitive) The PagerDuty recipient's integration key -- if of type pagerduty.
    integrationName String
    The PagerDuty recipient's integration name -- if of type pagerduty.
    name String
    The webhook recipient's name -- if of type webhook or msteams.
    secret String
    (Sensitive) The webhook recipient's secret -- if of type webhook.
    type String
    url String
    The webhook recipient's URL - if of type webhook, msteams or msteams_workflow.
    dataset String

    Deprecated: Deprecated

    detailFilter GetRecipientDetailFilter
    target String

    Deprecated: Deprecated

    address string
    The email recipient's address -- if of type email.
    channel string
    The Slack recipient's channel -- if of type slack.
    id string
    ID of the recipient.
    integrationKey string
    (Sensitive) The PagerDuty recipient's integration key -- if of type pagerduty.
    integrationName string
    The PagerDuty recipient's integration name -- if of type pagerduty.
    name string
    The webhook recipient's name -- if of type webhook or msteams.
    secret string
    (Sensitive) The webhook recipient's secret -- if of type webhook.
    type string
    url string
    The webhook recipient's URL - if of type webhook, msteams or msteams_workflow.
    dataset string

    Deprecated: Deprecated

    detailFilter GetRecipientDetailFilter
    target string

    Deprecated: Deprecated

    address str
    The email recipient's address -- if of type email.
    channel str
    The Slack recipient's channel -- if of type slack.
    id str
    ID of the recipient.
    integration_key str
    (Sensitive) The PagerDuty recipient's integration key -- if of type pagerduty.
    integration_name str
    The PagerDuty recipient's integration name -- if of type pagerduty.
    name str
    The webhook recipient's name -- if of type webhook or msteams.
    secret str
    (Sensitive) The webhook recipient's secret -- if of type webhook.
    type str
    url str
    The webhook recipient's URL - if of type webhook, msteams or msteams_workflow.
    dataset str

    Deprecated: Deprecated

    detail_filter GetRecipientDetailFilter
    target str

    Deprecated: Deprecated

    address String
    The email recipient's address -- if of type email.
    channel String
    The Slack recipient's channel -- if of type slack.
    id String
    ID of the recipient.
    integrationKey String
    (Sensitive) The PagerDuty recipient's integration key -- if of type pagerduty.
    integrationName String
    The PagerDuty recipient's integration name -- if of type pagerduty.
    name String
    The webhook recipient's name -- if of type webhook or msteams.
    secret String
    (Sensitive) The webhook recipient's secret -- if of type webhook.
    type String
    url String
    The webhook recipient's URL - if of type webhook, msteams or msteams_workflow.
    dataset String

    Deprecated: Deprecated

    detailFilter Property Map
    target String

    Deprecated: Deprecated

    Supporting Types

    GetRecipientDetailFilter

    Name string
    The name of the detail field to filter by. Allowed values are address, channel, name, integration_name, and url.
    Value string
    The value of the detail field to match on.
    ValueRegex string

    A regular expression string to apply to the value of the detail field to match on.

    Note one of value or value_regex is required.

    Name string
    The name of the detail field to filter by. Allowed values are address, channel, name, integration_name, and url.
    Value string
    The value of the detail field to match on.
    ValueRegex string

    A regular expression string to apply to the value of the detail field to match on.

    Note one of value or value_regex is required.

    name String
    The name of the detail field to filter by. Allowed values are address, channel, name, integration_name, and url.
    value String
    The value of the detail field to match on.
    valueRegex String

    A regular expression string to apply to the value of the detail field to match on.

    Note one of value or value_regex is required.

    name string
    The name of the detail field to filter by. Allowed values are address, channel, name, integration_name, and url.
    value string
    The value of the detail field to match on.
    valueRegex string

    A regular expression string to apply to the value of the detail field to match on.

    Note one of value or value_regex is required.

    name str
    The name of the detail field to filter by. Allowed values are address, channel, name, integration_name, and url.
    value str
    The value of the detail field to match on.
    value_regex str

    A regular expression string to apply to the value of the detail field to match on.

    Note one of value or value_regex is required.

    name String
    The name of the detail field to filter by. Allowed values are address, channel, name, integration_name, and url.
    value String
    The value of the detail field to match on.
    valueRegex String

    A regular expression string to apply to the value of the detail field to match on.

    Note one of value or value_regex is required.

    Package Details

    Repository
    honeycombio honeycombio/terraform-provider-honeycombio
    License
    Notes
    This Pulumi package is based on the honeycombio Terraform Provider.
    honeycombio logo
    Honeycomb 0.42.0 published on Friday, Oct 10, 2025 by honeycombio
    honeycombio/terraform-provider-honeycombio
      Meet Neo: Your AI Platform Teammate