Class: ModerationAPI::Resources::WebhookSecret

Inherits:

Object

• Object
• ModerationAPI::Resources::WebhookSecret

Defined in:

lib/moderation_api/resources/webhook_secret.rb,
sig/moderation_api/resources/webhook_secret.rbs

Instance Method Summary

• #initialize(client:) ⇒ WebhookSecret constructor private

  A new instance of WebhookSecret.

• #retrieve(request_options: {}) ⇒ ModerationAPI::Models::WebhookSecretRetrieveResponse

  Get the signing secret used to sign webhook deliveries for this project, creating one if none exists yet.

Constructor Details

#initialize(client:) ⇒ WebhookSecret

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of WebhookSecret.

Parameters:

• client (ModerationAPI::Client)
• client: (ModerationAPI::Client)

# File 'lib/moderation_api/resources/webhook_secret.rb', line 29

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(request_options: {}) ⇒ ModerationAPI::Models::WebhookSecretRetrieveResponse

Get the signing secret used to sign webhook deliveries for this project, creating one if none exists yet. Verify deliveries by comparing the modapi-signature header to HMAC-SHA256(raw request body, secret) hex-encoded.

Parameters:

• request_options (ModerationAPI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (ModerationAPI::Models::WebhookSecretRetrieveResponse)

See Also:

• Models::WebhookSecretRetrieveParams

# File 'lib/moderation_api/resources/webhook_secret.rb', line 17

def retrieve(params = {})
  @client.request(
    method: :get,
    path: "webhook-secret",
    model: ModerationAPI::Models::WebhookSecretRetrieveResponse,
    options: params[:request_options]
  )
end