Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

webhooks

package

Go to main page

Versions in this module

v1

v1.12.0

Jul 30, 2025

v1.11.1

Jul 22, 2025

v1.11.0

Jul 16, 2025

v1.10.3

Jul 15, 2025

v1.10.2

Jul 15, 2025

v1.10.1

Jul 11, 2025

v1.10.0

Jul 10, 2025

v1.9.0

Jul 10, 2025

v1.8.3

Jul 8, 2025

v1.8.2

Jun 27, 2025

v1.8.1

Jun 26, 2025

v1.8.0

Jun 26, 2025

Changes in this version

+ const ChatModelChatgpt4oLatest

+ const ChatModelCodexMiniLatest

+ const ChatModelGPT3_5Turbo

+ const ChatModelGPT3_5Turbo0125

+ const ChatModelGPT3_5Turbo0301

+ const ChatModelGPT3_5Turbo0613

+ const ChatModelGPT3_5Turbo1106

+ const ChatModelGPT3_5Turbo16k

+ const ChatModelGPT3_5Turbo16k0613

+ const ChatModelGPT4

+ const ChatModelGPT4Turbo

+ const ChatModelGPT4Turbo2024_04_09

+ const ChatModelGPT4TurboPreview

+ const ChatModelGPT4VisionPreview

+ const ChatModelGPT4_0125Preview

+ const ChatModelGPT4_0314

+ const ChatModelGPT4_0613

+ const ChatModelGPT4_1

+ const ChatModelGPT4_1106Preview

+ const ChatModelGPT4_1Mini

+ const ChatModelGPT4_1Mini2025_04_14

+ const ChatModelGPT4_1Nano

+ const ChatModelGPT4_1Nano2025_04_14

+ const ChatModelGPT4_1_2025_04_14

+ const ChatModelGPT4_32k

+ const ChatModelGPT4_32k0314

+ const ChatModelGPT4_32k0613

+ const ChatModelGPT4o

+ const ChatModelGPT4o2024_05_13

+ const ChatModelGPT4o2024_08_06

+ const ChatModelGPT4o2024_11_20

+ const ChatModelGPT4oAudioPreview

+ const ChatModelGPT4oAudioPreview2024_10_01

+ const ChatModelGPT4oAudioPreview2024_12_17

+ const ChatModelGPT4oAudioPreview2025_06_03

+ const ChatModelGPT4oMini

+ const ChatModelGPT4oMini2024_07_18

+ const ChatModelGPT4oMiniAudioPreview

+ const ChatModelGPT4oMiniAudioPreview2024_12_17

+ const ChatModelGPT4oMiniSearchPreview

+ const ChatModelGPT4oMiniSearchPreview2025_03_11

+ const ChatModelGPT4oSearchPreview

+ const ChatModelGPT4oSearchPreview2025_03_11

+ const ChatModelO1

+ const ChatModelO1Mini

+ const ChatModelO1Mini2024_09_12

+ const ChatModelO1Preview

+ const ChatModelO1Preview2024_09_12

+ const ChatModelO1_2024_12_17

+ const ChatModelO3

+ const ChatModelO3Mini

+ const ChatModelO3Mini2025_01_31

+ const ChatModelO3_2025_04_16

+ const ChatModelO4Mini

+ const ChatModelO4Mini2025_04_16

+ const ComparisonFilterTypeEq

+ const ComparisonFilterTypeGt

+ const ComparisonFilterTypeGte

+ const ComparisonFilterTypeLt

+ const ComparisonFilterTypeLte

+ const ComparisonFilterTypeNe

+ const CompoundFilterTypeAnd

+ const CompoundFilterTypeOr

+ const ReasoningEffortHigh

+ const ReasoningEffortLow

+ const ReasoningEffortMedium

+ const ReasoningGenerateSummaryAuto

+ const ReasoningGenerateSummaryConcise

+ const ReasoningGenerateSummaryDetailed

+ const ReasoningSummaryAuto

+ const ReasoningSummaryConcise

+ const ReasoningSummaryDetailed

+ const ResponsesModelComputerUsePreview

+ const ResponsesModelComputerUsePreview2025_03_11

+ const ResponsesModelO1Pro

+ const ResponsesModelO1Pro2025_03_19

+ const ResponsesModelO3DeepResearch

+ const ResponsesModelO3DeepResearch2025_06_26

+ const ResponsesModelO3Pro

+ const ResponsesModelO3Pro2025_06_10

+ const ResponsesModelO4MiniDeepResearch

+ const ResponsesModelO4MiniDeepResearch2025_06_26

+ type BatchCancelledWebhookEvent struct

+ CreatedAt int64

+ Data BatchCancelledWebhookEventData

+ ID string

+ JSON struct{ ... }

+ Object BatchCancelledWebhookEventObject

+ Type constant.BatchCancelled

+ func (r *BatchCancelledWebhookEvent) UnmarshalJSON(data []byte) error

+ func (r BatchCancelledWebhookEvent) RawJSON() string

+ type BatchCancelledWebhookEventData struct

+ ID string

+ JSON struct{ ... }

+ func (r *BatchCancelledWebhookEventData) UnmarshalJSON(data []byte) error

+ func (r BatchCancelledWebhookEventData) RawJSON() string

+ type BatchCancelledWebhookEventObject string

+ const BatchCancelledWebhookEventObjectEvent

+ type BatchCompletedWebhookEvent struct

+ CreatedAt int64

+ Data BatchCompletedWebhookEventData

+ ID string

+ JSON struct{ ... }

+ Object BatchCompletedWebhookEventObject

+ Type constant.BatchCompleted

+ func (r *BatchCompletedWebhookEvent) UnmarshalJSON(data []byte) error

+ func (r BatchCompletedWebhookEvent) RawJSON() string

+ type BatchCompletedWebhookEventData struct

+ ID string

+ JSON struct{ ... }

+ func (r *BatchCompletedWebhookEventData) UnmarshalJSON(data []byte) error

+ func (r BatchCompletedWebhookEventData) RawJSON() string

+ type BatchCompletedWebhookEventObject string

+ const BatchCompletedWebhookEventObjectEvent

+ type BatchExpiredWebhookEvent struct

+ CreatedAt int64

+ Data BatchExpiredWebhookEventData

+ ID string

+ JSON struct{ ... }

+ Object BatchExpiredWebhookEventObject

+ Type constant.BatchExpired

+ func (r *BatchExpiredWebhookEvent) UnmarshalJSON(data []byte) error

+ func (r BatchExpiredWebhookEvent) RawJSON() string

+ type BatchExpiredWebhookEventData struct

+ ID string

+ JSON struct{ ... }

+ func (r *BatchExpiredWebhookEventData) UnmarshalJSON(data []byte) error

+ func (r BatchExpiredWebhookEventData) RawJSON() string

+ type BatchExpiredWebhookEventObject string

+ const BatchExpiredWebhookEventObjectEvent

+ type BatchFailedWebhookEvent struct

+ CreatedAt int64

+ Data BatchFailedWebhookEventData

+ ID string

+ JSON struct{ ... }

+ Object BatchFailedWebhookEventObject

+ Type constant.BatchFailed

+ func (r *BatchFailedWebhookEvent) UnmarshalJSON(data []byte) error

+ func (r BatchFailedWebhookEvent) RawJSON() string

+ type BatchFailedWebhookEventData struct

+ ID string

+ JSON struct{ ... }

+ func (r *BatchFailedWebhookEventData) UnmarshalJSON(data []byte) error

+ func (r BatchFailedWebhookEventData) RawJSON() string

+ type BatchFailedWebhookEventObject string

+ const BatchFailedWebhookEventObjectEvent

+ type ChatModel = shared.ChatModel

+ type ComparisonFilter = shared.ComparisonFilter

+ type ComparisonFilterParam = shared.ComparisonFilterParam

+ type ComparisonFilterType = shared.ComparisonFilterType

+ type ComparisonFilterValueUnion = shared.ComparisonFilterValueUnion

+ type ComparisonFilterValueUnionParam = shared.ComparisonFilterValueUnionParam

+ type CompoundFilter = shared.CompoundFilter

+ type CompoundFilterParam = shared.CompoundFilterParam

+ type CompoundFilterType = shared.CompoundFilterType

+ type Error = apierror.Error

+ type ErrorObject = shared.ErrorObject

+ type EvalRunCanceledWebhookEvent struct

+ CreatedAt int64

+ Data EvalRunCanceledWebhookEventData

+ ID string

+ JSON struct{ ... }

+ Object EvalRunCanceledWebhookEventObject

+ Type constant.EvalRunCanceled

+ func (r *EvalRunCanceledWebhookEvent) UnmarshalJSON(data []byte) error

+ func (r EvalRunCanceledWebhookEvent) RawJSON() string

+ type EvalRunCanceledWebhookEventData struct

+ ID string

+ JSON struct{ ... }

+ func (r *EvalRunCanceledWebhookEventData) UnmarshalJSON(data []byte) error

+ func (r EvalRunCanceledWebhookEventData) RawJSON() string

+ type EvalRunCanceledWebhookEventObject string

+ const EvalRunCanceledWebhookEventObjectEvent

+ type EvalRunFailedWebhookEvent struct

+ CreatedAt int64

+ Data EvalRunFailedWebhookEventData

+ ID string

+ JSON struct{ ... }

+ Object EvalRunFailedWebhookEventObject

+ Type constant.EvalRunFailed

+ func (r *EvalRunFailedWebhookEvent) UnmarshalJSON(data []byte) error

+ func (r EvalRunFailedWebhookEvent) RawJSON() string

+ type EvalRunFailedWebhookEventData struct

+ ID string

+ JSON struct{ ... }

+ func (r *EvalRunFailedWebhookEventData) UnmarshalJSON(data []byte) error

+ func (r EvalRunFailedWebhookEventData) RawJSON() string

+ type EvalRunFailedWebhookEventObject string

+ const EvalRunFailedWebhookEventObjectEvent

+ type EvalRunSucceededWebhookEvent struct

+ CreatedAt int64

+ Data EvalRunSucceededWebhookEventData

+ ID string

+ JSON struct{ ... }

+ Object EvalRunSucceededWebhookEventObject

+ Type constant.EvalRunSucceeded

+ func (r *EvalRunSucceededWebhookEvent) UnmarshalJSON(data []byte) error

+ func (r EvalRunSucceededWebhookEvent) RawJSON() string

+ type EvalRunSucceededWebhookEventData struct

+ ID string

+ JSON struct{ ... }

+ func (r *EvalRunSucceededWebhookEventData) UnmarshalJSON(data []byte) error

+ func (r EvalRunSucceededWebhookEventData) RawJSON() string

+ type EvalRunSucceededWebhookEventObject string

+ const EvalRunSucceededWebhookEventObjectEvent

+ type FineTuningJobCancelledWebhookEvent struct

+ CreatedAt int64

+ Data FineTuningJobCancelledWebhookEventData

+ ID string

+ JSON struct{ ... }

+ Object FineTuningJobCancelledWebhookEventObject

+ Type constant.FineTuningJobCancelled

+ func (r *FineTuningJobCancelledWebhookEvent) UnmarshalJSON(data []byte) error

+ func (r FineTuningJobCancelledWebhookEvent) RawJSON() string

+ type FineTuningJobCancelledWebhookEventData struct

+ ID string

+ JSON struct{ ... }

+ func (r *FineTuningJobCancelledWebhookEventData) UnmarshalJSON(data []byte) error

+ func (r FineTuningJobCancelledWebhookEventData) RawJSON() string

+ type FineTuningJobCancelledWebhookEventObject string

+ const FineTuningJobCancelledWebhookEventObjectEvent

+ type FineTuningJobFailedWebhookEvent struct

+ CreatedAt int64

+ Data FineTuningJobFailedWebhookEventData

+ ID string

+ JSON struct{ ... }

+ Object FineTuningJobFailedWebhookEventObject

+ Type constant.FineTuningJobFailed

+ func (r *FineTuningJobFailedWebhookEvent) UnmarshalJSON(data []byte) error

+ func (r FineTuningJobFailedWebhookEvent) RawJSON() string

+ type FineTuningJobFailedWebhookEventData struct

+ ID string

+ JSON struct{ ... }

+ func (r *FineTuningJobFailedWebhookEventData) UnmarshalJSON(data []byte) error

+ func (r FineTuningJobFailedWebhookEventData) RawJSON() string

+ type FineTuningJobFailedWebhookEventObject string

+ const FineTuningJobFailedWebhookEventObjectEvent

+ type FineTuningJobSucceededWebhookEvent struct

+ CreatedAt int64

+ Data FineTuningJobSucceededWebhookEventData

+ ID string

+ JSON struct{ ... }

+ Object FineTuningJobSucceededWebhookEventObject

+ Type constant.FineTuningJobSucceeded

+ func (r *FineTuningJobSucceededWebhookEvent) UnmarshalJSON(data []byte) error

+ func (r FineTuningJobSucceededWebhookEvent) RawJSON() string

+ type FineTuningJobSucceededWebhookEventData struct

+ ID string

+ JSON struct{ ... }

+ func (r *FineTuningJobSucceededWebhookEventData) UnmarshalJSON(data []byte) error

+ func (r FineTuningJobSucceededWebhookEventData) RawJSON() string

+ type FineTuningJobSucceededWebhookEventObject string

+ const FineTuningJobSucceededWebhookEventObjectEvent

+ type FunctionDefinition = shared.FunctionDefinition

+ type FunctionDefinitionParam = shared.FunctionDefinitionParam

+ type FunctionParameters = shared.FunctionParameters

+ type Metadata = shared.Metadata

+ type Reasoning = shared.Reasoning

+ type ReasoningEffort = shared.ReasoningEffort

+ type ReasoningGenerateSummary = shared.ReasoningGenerateSummary

+ type ReasoningParam = shared.ReasoningParam

+ type ReasoningSummary = shared.ReasoningSummary

+ type ResponseCancelledWebhookEvent struct

+ CreatedAt int64

+ Data ResponseCancelledWebhookEventData

+ ID string

+ JSON struct{ ... }

+ Object ResponseCancelledWebhookEventObject

+ Type constant.ResponseCancelled

+ func (r *ResponseCancelledWebhookEvent) UnmarshalJSON(data []byte) error

+ func (r ResponseCancelledWebhookEvent) RawJSON() string

+ type ResponseCancelledWebhookEventData struct

+ ID string

+ JSON struct{ ... }

+ func (r *ResponseCancelledWebhookEventData) UnmarshalJSON(data []byte) error

+ func (r ResponseCancelledWebhookEventData) RawJSON() string

+ type ResponseCancelledWebhookEventObject string

+ const ResponseCancelledWebhookEventObjectEvent

+ type ResponseCompletedWebhookEvent struct

+ CreatedAt int64

+ Data ResponseCompletedWebhookEventData

+ ID string

+ JSON struct{ ... }

+ Object ResponseCompletedWebhookEventObject

+ Type constant.ResponseCompleted

+ func (r *ResponseCompletedWebhookEvent) UnmarshalJSON(data []byte) error

+ func (r ResponseCompletedWebhookEvent) RawJSON() string

+ type ResponseCompletedWebhookEventData struct

+ ID string

+ JSON struct{ ... }

+ func (r *ResponseCompletedWebhookEventData) UnmarshalJSON(data []byte) error

+ func (r ResponseCompletedWebhookEventData) RawJSON() string

+ type ResponseCompletedWebhookEventObject string

+ const ResponseCompletedWebhookEventObjectEvent

+ type ResponseFailedWebhookEvent struct

+ CreatedAt int64

+ Data ResponseFailedWebhookEventData

+ ID string

+ JSON struct{ ... }

+ Object ResponseFailedWebhookEventObject

+ Type constant.ResponseFailed

+ func (r *ResponseFailedWebhookEvent) UnmarshalJSON(data []byte) error

+ func (r ResponseFailedWebhookEvent) RawJSON() string

+ type ResponseFailedWebhookEventData struct

+ ID string

+ JSON struct{ ... }

+ func (r *ResponseFailedWebhookEventData) UnmarshalJSON(data []byte) error

+ func (r ResponseFailedWebhookEventData) RawJSON() string

+ type ResponseFailedWebhookEventObject string

+ const ResponseFailedWebhookEventObjectEvent

+ type ResponseFormatJSONObject = shared.ResponseFormatJSONObject

+ type ResponseFormatJSONObjectParam = shared.ResponseFormatJSONObjectParam

+ type ResponseFormatJSONSchema = shared.ResponseFormatJSONSchema

+ type ResponseFormatJSONSchemaJSONSchema = shared.ResponseFormatJSONSchemaJSONSchema

+ type ResponseFormatJSONSchemaJSONSchemaParam = shared.ResponseFormatJSONSchemaJSONSchemaParam

+ type ResponseFormatJSONSchemaParam = shared.ResponseFormatJSONSchemaParam

+ type ResponseFormatText = shared.ResponseFormatText

+ type ResponseFormatTextParam = shared.ResponseFormatTextParam

+ type ResponseIncompleteWebhookEvent struct

+ CreatedAt int64

+ Data ResponseIncompleteWebhookEventData

+ ID string

+ JSON struct{ ... }

+ Object ResponseIncompleteWebhookEventObject

+ Type constant.ResponseIncomplete

+ func (r *ResponseIncompleteWebhookEvent) UnmarshalJSON(data []byte) error

+ func (r ResponseIncompleteWebhookEvent) RawJSON() string

+ type ResponseIncompleteWebhookEventData struct

+ ID string

+ JSON struct{ ... }

+ func (r *ResponseIncompleteWebhookEventData) UnmarshalJSON(data []byte) error

+ func (r ResponseIncompleteWebhookEventData) RawJSON() string

+ type ResponseIncompleteWebhookEventObject string

+ const ResponseIncompleteWebhookEventObjectEvent

+ type ResponsesModel = shared.ResponsesModel

+ type UnwrapWebhookEventUnion struct

+ CreatedAt int64

+ Data UnwrapWebhookEventUnionData

+ ID string

+ JSON struct{ ... }

+ Object string

+ Type string

+ func (r *UnwrapWebhookEventUnion) UnmarshalJSON(data []byte) error

+ func (u UnwrapWebhookEventUnion) AsAny() anyUnwrapWebhookEvent

+ func (u UnwrapWebhookEventUnion) AsBatchCancelled() (v BatchCancelledWebhookEvent)

+ func (u UnwrapWebhookEventUnion) AsBatchCompleted() (v BatchCompletedWebhookEvent)

+ func (u UnwrapWebhookEventUnion) AsBatchExpired() (v BatchExpiredWebhookEvent)

+ func (u UnwrapWebhookEventUnion) AsBatchFailed() (v BatchFailedWebhookEvent)

+ func (u UnwrapWebhookEventUnion) AsEvalRunCanceled() (v EvalRunCanceledWebhookEvent)

+ func (u UnwrapWebhookEventUnion) AsEvalRunFailed() (v EvalRunFailedWebhookEvent)

+ func (u UnwrapWebhookEventUnion) AsEvalRunSucceeded() (v EvalRunSucceededWebhookEvent)

+ func (u UnwrapWebhookEventUnion) AsFineTuningJobCancelled() (v FineTuningJobCancelledWebhookEvent)

+ func (u UnwrapWebhookEventUnion) AsFineTuningJobFailed() (v FineTuningJobFailedWebhookEvent)

+ func (u UnwrapWebhookEventUnion) AsFineTuningJobSucceeded() (v FineTuningJobSucceededWebhookEvent)

+ func (u UnwrapWebhookEventUnion) AsResponseCancelled() (v ResponseCancelledWebhookEvent)

+ func (u UnwrapWebhookEventUnion) AsResponseCompleted() (v ResponseCompletedWebhookEvent)

+ func (u UnwrapWebhookEventUnion) AsResponseFailed() (v ResponseFailedWebhookEvent)

+ func (u UnwrapWebhookEventUnion) AsResponseIncomplete() (v ResponseIncompleteWebhookEvent)

+ func (u UnwrapWebhookEventUnion) RawJSON() string

+ type UnwrapWebhookEventUnionData struct

+ ID string

+ JSON struct{ ... }

+ func (r *UnwrapWebhookEventUnionData) UnmarshalJSON(data []byte) error

+ type WebhookService struct

+ Options []option.RequestOption

+ func NewWebhookService(opts ...option.RequestOption) (r WebhookService)

+ func (r *WebhookService) Unwrap(body []byte, headers http.Header, opts ...option.RequestOption) (*UnwrapWebhookEventUnion, error)

+ func (r *WebhookService) UnwrapWithTolerance(body []byte, headers http.Header, tolerance time.Duration, ...) (*UnwrapWebhookEventUnion, error)

+ func (r *WebhookService) UnwrapWithToleranceAndTime(body []byte, headers http.Header, tolerance time.Duration, now time.Time, ...) (*UnwrapWebhookEventUnion, error)

+ func (r *WebhookService) VerifySignature(body []byte, headers http.Header, opts ...option.RequestOption) error

+ func (r *WebhookService) VerifySignatureWithTolerance(body []byte, headers http.Header, tolerance time.Duration, ...) error

+ func (r *WebhookService) VerifySignatureWithToleranceAndTime(body []byte, headers http.Header, tolerance time.Duration, now time.Time, ...) error

Other modules containing this package

github.com/openai/openai-go/v2