1. Packages
  2. Logfire
  3. API Docs
  4. Channel
Viewing docs for Logfire v0.1.9
published on Wednesday, Apr 8, 2026 by Pydantic
Schema (JSON)
pydantic/pulumi-logfire

logfire.Channel

logfire logo
Viewing docs for Logfire v0.1.9
published on Wednesday, Apr 8, 2026 by Pydantic
Schema (JSON)
pydantic/pulumi-logfire

    Manages a Logfire alert channel.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as logfire from "@pydantic/pulumi-logfire";

const example = new logfire.Channel("example", {
    active: true,
    config: {
        format: "auto",
        type: "webhook",
        url: "https://example.com/logfire-webhook",
    },
});

    import pulumi
import pulumi_logfire as logfire

example = logfire.Channel("example",
    active=True,
    config={
        "format": "auto",
        "type": "webhook",
        "url": "https://example.com/logfire-webhook",
    })

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pydantic/pulumi-logfire/sdk/go/logfire"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := logfire.NewChannel(ctx, "example", &logfire.ChannelArgs{
			Active: pulumi.Bool(true),
			Config: &logfire.ChannelConfigArgs{
				Format: pulumi.String("auto"),
				Type:   pulumi.String("webhook"),
				Url:    pulumi.String("https://example.com/logfire-webhook"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Logfire.Channel("example", new()
    {
        Active = true,
        Config = new Logfire.Inputs.ChannelConfigArgs
        {
            Format = "auto",
            Type = "webhook",
            Url = "https://example.com/logfire-webhook",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.logfire.Channel;
import com.pulumi.logfire.ChannelArgs;
import com.pulumi.logfire.inputs.ChannelConfigArgs;
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) {
        var example = new Channel("example", ChannelArgs.builder()
            .active(true)
            .config(ChannelConfigArgs.builder()
                .format("auto")
                .type("webhook")
                .url("https://example.com/logfire-webhook")
                .build())
            .build());

    }
}

    resources:
  example:
    type: logfire:Channel
    properties:
      active: true
      config:
        format: auto
        type: webhook
        url: https://example.com/logfire-webhook

    Create Channel Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Channel(name: string, args?: ChannelArgs, opts?: CustomResourceOptions);
    @overload
def Channel(resource_name: str,
            args: Optional[ChannelArgs] = None,
            opts: Optional[ResourceOptions] = None)

@overload
def Channel(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            active: Optional[bool] = None,
            config: Optional[ChannelConfigArgs] = None,
            name: Optional[str] = None)
    func NewChannel(ctx *Context, name string, args *ChannelArgs, opts ...ResourceOption) (*Channel, error)
    public Channel(string name, ChannelArgs? args = null, CustomResourceOptions? opts = null)
    public Channel(String name, ChannelArgs args)
public Channel(String name, ChannelArgs args, CustomResourceOptions options)

    type: logfire:Channel
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ChannelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ChannelArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ChannelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ChannelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ChannelArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var channelResource = new Logfire.Index.Channel("channelResource", new()
{
    Active = false,
    Config = new Logfire.Inputs.ChannelConfigArgs
    {
        Type = "string",
        AuthKey = "string",
        Format = "string",
        Url = "string",
    },
    Name = "string",
});

    example, err := logfire.NewChannel(ctx, "channelResource", &logfire.ChannelArgs{
	Active: pulumi.Bool(false),
	Config: &logfire.ChannelConfigArgs{
		Type:    pulumi.String("string"),
		AuthKey: pulumi.String("string"),
		Format:  pulumi.String("string"),
		Url:     pulumi.String("string"),
	},
	Name: pulumi.String("string"),
})

    var channelResource = new Channel("channelResource", ChannelArgs.builder()
    .active(false)
    .config(ChannelConfigArgs.builder()
        .type("string")
        .authKey("string")
        .format("string")
        .url("string")
        .build())
    .name("string")
    .build());

    channel_resource = logfire.Channel("channelResource",
    active=False,
    config={
        "type": "string",
        "auth_key": "string",
        "format": "string",
        "url": "string",
    },
    name="string")

    const channelResource = new logfire.Channel("channelResource", {
    active: false,
    config: {
        type: "string",
        authKey: "string",
        format: "string",
        url: "string",
    },
    name: "string",
});

    type: logfire:Channel
properties:
    active: false
    config:
        authKey: string
        format: string
        type: string
        url: string
    name: string

    Channel Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Channel resource accepts the following input properties:

    Active bool
    Whether the channel is active.
    Config ChannelConfig
    Required channel configuration.
    Name string
    Channel name.
    Active bool
    Whether the channel is active.
    Config ChannelConfigArgs
    Required channel configuration.
    Name string
    Channel name.
    active Boolean
    Whether the channel is active.
    config ChannelConfig
    Required channel configuration.
    name String
    Channel name.
    active boolean
    Whether the channel is active.
    config ChannelConfig
    Required channel configuration.
    name string
    Channel name.
    active bool
    Whether the channel is active.
    config ChannelConfigArgs
    Required channel configuration.
    name str
    Channel name.
    active Boolean
    Whether the channel is active.
    config Property Map
    Required channel configuration.
    name String
    Channel name.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Channel resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Channel Resource

    Get an existing Channel resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ChannelState, opts?: CustomResourceOptions): Channel
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active: Optional[bool] = None,
        config: Optional[ChannelConfigArgs] = None,
        name: Optional[str] = None) -> Channel
    func GetChannel(ctx *Context, name string, id IDInput, state *ChannelState, opts ...ResourceOption) (*Channel, error)
    public static Channel Get(string name, Input<string> id, ChannelState? state, CustomResourceOptions? opts = null)
    public static Channel get(String name, Output<String> id, ChannelState state, CustomResourceOptions options)
    resources:  _:    type: logfire:Channel    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Active bool
    Whether the channel is active.
    Config ChannelConfig
    Required channel configuration.
    Name string
    Channel name.
    Active bool
    Whether the channel is active.
    Config ChannelConfigArgs
    Required channel configuration.
    Name string
    Channel name.
    active Boolean
    Whether the channel is active.
    config ChannelConfig
    Required channel configuration.
    name String
    Channel name.
    active boolean
    Whether the channel is active.
    config ChannelConfig
    Required channel configuration.
    name string
    Channel name.
    active bool
    Whether the channel is active.
    config ChannelConfigArgs
    Required channel configuration.
    name str
    Channel name.
    active Boolean
    Whether the channel is active.
    config Property Map
    Required channel configuration.
    name String
    Channel name.

    Supporting Types

    ChannelConfig, ChannelConfigArgs

    Type string
    Channel type (webhook or opsgenie).
    AuthKey string
    Opsgenie API key.
    Format string
    Webhook payload format.
    Url string
    Webhook URL endpoint.
    Type string
    Channel type (webhook or opsgenie).
    AuthKey string
    Opsgenie API key.
    Format string
    Webhook payload format.
    Url string
    Webhook URL endpoint.
    type String
    Channel type (webhook or opsgenie).
    authKey String
    Opsgenie API key.
    format String
    Webhook payload format.
    url String
    Webhook URL endpoint.
    type string
    Channel type (webhook or opsgenie).
    authKey string
    Opsgenie API key.
    format string
    Webhook payload format.
    url string
    Webhook URL endpoint.
    type str
    Channel type (webhook or opsgenie).
    auth_key str
    Opsgenie API key.
    format str
    Webhook payload format.
    url str
    Webhook URL endpoint.
    type String
    Channel type (webhook or opsgenie).
    authKey String
    Opsgenie API key.
    format String
    Webhook payload format.
    url String
    Webhook URL endpoint.

    Package Details

    Repository
    logfire pydantic/pulumi-logfire
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the logfire Terraform Provider.
    logfire logo
    Viewing docs for Logfire v0.1.9
    published on Wednesday, Apr 8, 2026 by Pydantic
    Schema (JSON)
    pydantic/pulumi-logfire
      Try Pulumi Cloud free. Your team will thank you.