Replace a webhook

client.RealtimeKit.Webhooks.ReplaceWebhook(ctx, appID, webhookID, params) (*WebhookReplaceWebhookResponse, error)

PUT/accounts/{account_id}/realtime/kit/{app_id}/webhooks/{webhook_id}

Replace all details for the given webhook ID.

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)

Realtime AdminRealtime

ParametersExpand Collapse

appID string

The app identifier tag.

webhookID string

formatuuid

params WebhookReplaceWebhookParams

AccountID param.Field[string]

Path param: The account identifier tag.

maxLength32

Events param.Field[[]WebhookReplaceWebhookParamsEvent]

Body param: Events that this webhook will get triggered by

const WebhookReplaceWebhookParamsEventMeetingStarted WebhookReplaceWebhookParamsEvent = "meeting.started"

const WebhookReplaceWebhookParamsEventMeetingEnded WebhookReplaceWebhookParamsEvent = "meeting.ended"

const WebhookReplaceWebhookParamsEventMeetingParticipantJoined WebhookReplaceWebhookParamsEvent = "meeting.participantJoined"

const WebhookReplaceWebhookParamsEventMeetingParticipantLeft WebhookReplaceWebhookParamsEvent = "meeting.participantLeft"

const WebhookReplaceWebhookParamsEventMeetingChatSynced WebhookReplaceWebhookParamsEvent = "meeting.chatSynced"

const WebhookReplaceWebhookParamsEventRecordingStatusUpdate WebhookReplaceWebhookParamsEvent = "recording.statusUpdate"

const WebhookReplaceWebhookParamsEventLivestreamingStatusUpdate WebhookReplaceWebhookParamsEvent = "livestreaming.statusUpdate"

const WebhookReplaceWebhookParamsEventMeetingTranscript WebhookReplaceWebhookParamsEvent = "meeting.transcript"

const WebhookReplaceWebhookParamsEventMeetingSummary WebhookReplaceWebhookParamsEvent = "meeting.summary"

Name param.Field[string]

Body param: Name of the webhook

URL param.Field[string]

Body param: URL this webhook will send events to

formaturi

Enabled param.Field[bool]Optional

Body param: Set whether or not the webhook should be active when created

ReturnsExpand Collapse

type WebhookReplaceWebhookResponse struct{…}

Data WebhookReplaceWebhookResponseData

ID string

ID of the webhook

formatuuid

CreatedAt Time

Timestamp when this webhook was created

formatdate-time

Enabled bool

Set to true if the webhook is active

Events []WebhookReplaceWebhookResponseDataEvent

Events this webhook will send updates for

One of the following:

const WebhookReplaceWebhookResponseDataEventMeetingStarted WebhookReplaceWebhookResponseDataEvent = "meeting.started"

const WebhookReplaceWebhookResponseDataEventMeetingEnded WebhookReplaceWebhookResponseDataEvent = "meeting.ended"

const WebhookReplaceWebhookResponseDataEventMeetingParticipantJoined WebhookReplaceWebhookResponseDataEvent = "meeting.participantJoined"

const WebhookReplaceWebhookResponseDataEventMeetingParticipantLeft WebhookReplaceWebhookResponseDataEvent = "meeting.participantLeft"

const WebhookReplaceWebhookResponseDataEventMeetingChatSynced WebhookReplaceWebhookResponseDataEvent = "meeting.chatSynced"

const WebhookReplaceWebhookResponseDataEventRecordingStatusUpdate WebhookReplaceWebhookResponseDataEvent = "recording.statusUpdate"

const WebhookReplaceWebhookResponseDataEventLivestreamingStatusUpdate WebhookReplaceWebhookResponseDataEvent = "livestreaming.statusUpdate"

const WebhookReplaceWebhookResponseDataEventMeetingTranscript WebhookReplaceWebhookResponseDataEvent = "meeting.transcript"

const WebhookReplaceWebhookResponseDataEventMeetingSummary WebhookReplaceWebhookResponseDataEvent = "meeting.summary"

Name string

Name of the webhook

UpdatedAt Time

Timestamp when this webhook was updated

formatdate-time

URL string

URL the webhook will send events to

formaturi

Success bool

Replace a webhook

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/option"
  "github.com/cloudflare/cloudflare-go/realtime_kit"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  response, err := client.RealtimeKit.Webhooks.ReplaceWebhook(
    context.TODO(),
    "14a396e7-ca44-4937-bf1f-050a69118543",
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    realtime_kit.WebhookReplaceWebhookParams{
      AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
      Events: cloudflare.F([]realtime_kit.WebhookReplaceWebhookParamsEvent{realtime_kit.WebhookReplaceWebhookParamsEventMeetingStarted}),
      Name: cloudflare.F("My Webhook"),
      URL: cloudflare.F("https://example.com/webhook"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Data)
}

{
  "data": {
    "created_at": "2023-07-15T07:08:26.634Z",
    "enabled": true,
    "events": [
      "meeting.started"
    ],
    "id": "b6e0fd13-d7f4-4122-9ad5-7994b35d24b8",
    "name": "My Webhook",
    "updated_at": "2023-07-15T07:08:26.634Z",
    "url": "https://example.com/webhook"
  },
  "success": true
}

{
  "error": {
    "code": 400,
    "message": "BAD_REQUEST: \"id\" must be a valid GUID"
  },
  "success": false
}

"{\n  message: \"Unauthorized\"\n}\n"

Returns Examples

{
  "data": {
    "created_at": "2023-07-15T07:08:26.634Z",
    "enabled": true,
    "events": [
      "meeting.started"
    ],
    "id": "b6e0fd13-d7f4-4122-9ad5-7994b35d24b8",
    "name": "My Webhook",
    "updated_at": "2023-07-15T07:08:26.634Z",
    "url": "https://example.com/webhook"
  },
  "success": true
}

{
  "error": {
    "code": 400,
    "message": "BAD_REQUEST: \"id\" must be a valid GUID"
  },
  "success": false
}

"{\n  message: \"Unauthorized\"\n}\n"