Get a webhook

client.Alerting.Destinations.Webhooks.Get(ctx, webhookID, query) (*Webhooks, error)

GET/accounts/{account_id}/alerting/v3/destinations/webhooks/{webhook_id}

Get details for a single webhooks destination.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Zero Trust: PII ReadNotifications WriteNotifications ReadAccount Settings WriteAccount Settings Read

ParametersExpand Collapse

webhookID string

The unique identifier of a webhook

maxLength32

query DestinationWebhookGetParams

AccountID param.Field[string]

The account id

maxLength32

ReturnsExpand Collapse

type Webhooks struct{…}

ID stringOptional

The unique identifier of a webhook

maxLength32

CreatedAt TimeOptional

Timestamp of when the webhook destination was created.

formatdate-time

LastFailure TimeOptional

Timestamp of the last time an attempt to dispatch a notification to this webhook failed.

formatdate-time

LastSuccess TimeOptional

Timestamp of the last time Cloudflare was able to successfully dispatch a notification using this webhook.

formatdate-time

Name stringOptional

The name of the webhook destination. This will be included in the request body when you receive a webhook notification.

Secret stringOptional

Optional secret that will be passed in the cf-webhook-auth header when dispatching generic webhook notifications or formatted for supported destinations. Secrets are not returned in any API response body.

Type WebhooksTypeOptional

Type of webhook endpoint.

One of the following:

const WebhooksTypeDatadog WebhooksType = "datadog"

const WebhooksTypeDiscord WebhooksType = "discord"

const WebhooksTypeFeishu WebhooksType = "feishu"

const WebhooksTypeGchat WebhooksType = "gchat"

const WebhooksTypeGeneric WebhooksType = "generic"

const WebhooksTypeOpsgenie WebhooksType = "opsgenie"

const WebhooksTypeSlack WebhooksType = "slack"

const WebhooksTypeSplunk WebhooksType = "splunk"

URL stringOptional

The POST endpoint to call when dispatching a notification.

Get a webhook

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/cloudflare-go"
  "github.com/stainless-sdks/cloudflare-go/alerting"
  "github.com/stainless-sdks/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  webhooks, err := client.Alerting.Destinations.Webhooks.Get(
    context.TODO(),
    "b115d5ec15c641ee8b7692c449b5227b",
    alerting.DestinationWebhookGetParams{
      AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", webhooks.ID)
}

{
  "errors": [
    {
      "message": "message",
      "code": 1000
    }
  ],
  "messages": [
    {
      "message": "message",
      "code": 1000
    }
  ],
  "success": true,
  "result": {
    "id": "b115d5ec15c641ee8b7692c449b5227b",
    "created_at": "2020-10-26T18:25:04.532316Z",
    "last_failure": "2020-10-26T18:25:04.532316Z",
    "last_success": "2020-10-26T18:25:04.532316Z",
    "name": "Slack Webhook",
    "type": "slack",
    "url": "https://hooks.slack.com/services/Ds3fdBFbV/456464Gdd"
  }
}

Returns Examples

{
  "errors": [
    {
      "message": "message",
      "code": 1000
    }
  ],
  "messages": [
    {
      "message": "message",
      "code": 1000
    }
  ],
  "success": true,
  "result": {
    "id": "b115d5ec15c641ee8b7692c449b5227b",
    "created_at": "2020-10-26T18:25:04.532316Z",
    "last_failure": "2020-10-26T18:25:04.532316Z",
    "last_success": "2020-10-26T18:25:04.532316Z",
    "name": "Slack Webhook",
    "type": "slack",
    "url": "https://hooks.slack.com/services/Ds3fdBFbV/456464Gdd"
  }
}