Class: Contentful::Management::Webhook

Inherits:
Object
  • Object
show all
Includes:
Resource, Resource::Refresher, Resource::SystemProperties
Defined in:
lib/contentful/management/webhook.rb

Overview

Resource class for Webhook.

See Also:

  • https://www.contentful.com/developers/documentation/content-management-api/http/#resources-webhooks

Instance Attribute Summary

Attributes included from Resource::SystemProperties

#sys

Attributes included from Resource

#client, #properties, #raw_object, #request

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Resource::Refresher

#reload

Methods included from Resource

#array?, #default_locale, #destroy, #environment_id, #fields, #nested_locale_fields?, #resource?, #save, #sys, #update

Class Method Details

.create(client, space_id, attributes = {}) ⇒ Contentful::Management::Webhook

Creates a webhook.

Parameters:

Returns:

See Also:

  • README for full attribute list for each resource.


41
42
43
 
# File 'lib/contentful/management/webhook.rb', line 41

def self.create(client, space_id, attributes = {})
  super(client, space_id, nil, attributes)
end

.find(client, space_id, webhook_id) ⇒ Contentful::Management::Webhook

Finds a webhook by ID.

Parameters:

Returns:



52
53
54
 
# File 'lib/contentful/management/webhook.rb', line 52

def self.find(client, space_id, webhook_id)
  super(client, space_id, nil, webhook_id)
end

Instance Method Details

#webhook_calls ⇒ Contentful::Management::WebhookWebhookCallMethodsFactory

Allows manipulation of webhook call details in context of the current webhook Allows listing all webhook call details for the webhook and finding one by ID.

Returns:

  • (Contentful::Management::WebhookWebhookCallMethodsFactory)

See Also:

  • README for details.


61
62
63
 
# File 'lib/contentful/management/webhook.rb', line 61

def webhook_calls
  WebhookWebhookCallMethodsFactory.new(self)
end

#webhook_health ⇒ Contentful::Management::WebhookWebhookHealthMethodsFactory

Allows manipulation of webhook health details in context of the current webhook Allows listing webhook health details for the webhook.

Returns:

  • (Contentful::Management::WebhookWebhookHealthMethodsFactory)

See Also:

  • README for details.


70
71
72
 
# File 'lib/contentful/management/webhook.rb', line 70

def webhook_health
  WebhookWebhookHealthMethodsFactory.new(self)
end