C# Class System.Web.Http.HttpConfigurationExtensions

Show file Open project: aspnet/WebHooks

Public Methods

Method Description
InitializeCustomWebHooksAzureQueueSender ( this config ) : void

Configures a Microsoft Azure Table Storage implementation of IWebHookStore which provides a persistent store for registered WebHooks used by the custom WebHooks module.
InitializeCustomWebHooksAzureStorage ( this config ) : void

Configures a Microsoft Azure Table Storage implementation of IWebHookStore which provides a persistent store for registered WebHooks used by the custom WebHooks module. Using this initializer, the data will be encrypted using IDataProtector.
InitializeCustomWebHooksAzureStorage ( this config, bool encryptData ) : void

Configures a Microsoft Azure Table Storage implementation of IWebHookStore which provides a persistent store for registered WebHooks used by the custom WebHooks module.
InitializeCustomWebHooksSqlStorage ( this config ) : void

Configures a Microsoft SQL Server Storage implementation of IWebHookStore which provides a persistent store for registered WebHooks used by the custom WebHooks module. Using this initializer, the data will be encrypted using IDataProtector.
InitializeCustomWebHooksSqlStorage ( this config, bool encryptData ) : void

Configures a Microsoft SQL Server Storage implementation of IWebHookStore which provides a persistent store for registered WebHooks used by the custom WebHooks module.
InitializeReceiveGenericJsonWebHooks ( this config ) : void

Initializes support for receiving generic WebHooks containing valid JSON with no special validation logic or security requirements. This can for example be used to receive WebHooks from IFTTT's Maker Channel or a Zapier WebHooks Action. A sample WebHook URI is 'https://<host>/api/webhooks/incoming/genericjson/{id}?code=83699ec7c1d794c0c780e49a5c72972590571fd8'. For security reasons the WebHook URI must be an https URI and contain a 'code' query parameter with the same value as configured in the 'MS_WebHookReceiverSecret_GenericJson' application setting, optionally using IDs to differentiate between multiple WebHooks, for example 'secret0, id1=secret1, id2=secret2'. The 'code' parameter must be between 32 and 128 characters long. The URI may optionally include an 'action' query parameter which will serve as the WebHook action.
InitializeReceiveInstagramWebHooks ( this config ) : void

Initializes support for receiving Instagram WebHooks. Set the 'MS_WebHookReceiverSecret_Instagram' application setting to the application secrets, optionally using IDs to differentiate between multiple WebHooks, for example 'secret0, id1=secret1, id2=secret2'. The corresponding WebHook URI is of the form 'https://<host>/api/webhooks/incoming/instagram/{id}'. For details about Instagram WebHooks, see https://www.instagram.com/developer/subscriptions/.
InitializeReceiveMyGetWebHooks ( this config ) : void

Initializes support for receiving MyGet WebHooks. A sample WebHook URI is 'https://<host>/api/webhooks/incoming/myget/{id}?code=83699ec7c1d794c0c780e49a5c72972590571fd8'. For security reasons the WebHook URI must be an https URI and contain a 'code' query parameter with the same value as configured in the 'MS_WebHookReceiverSecret_MyGet' application setting. The 'code' parameter must be between 32 and 128 characters long. For details about MyGet WebHooks, see http://docs.myget.org/docs/reference/webhooks.
InitializeReceiveStripeDirectWebHooks ( this config ) : void

Initializes support for receiving Stripe WebHooks without any follow-up HTTP GET request to get the WebHook data. A sample WebHook URI is 'https://<host>/api/webhooks/incoming/stripe/{id}?code=83699ec7c1d794c0c780e49a5c72972590571fd8'. For security reasons the WebHook URI must be an https URI and contain a 'code' query parameter with the same value as configured in the 'MS_WebHookReceiverSecret_Stripe' application setting. The 'code' parameter must be between 32 and 128 characters long. For details about Stripe WebHooks, see https://stripe.com/docs/webhooks.
InitializeReceiveStripeWebHooks ( this config ) : void

Initializes support for receiving Stripe WebHooks. Set the 'MS_WebHookReceiverSecret_Stripe' application setting to the application key defined in Stripe. The corresponding WebHook URI is of the form 'https://<host>/api/webhooks/incoming/stripe/{id}'. As there is no code embedded in the URI, this mode will cause a follow-up HTTP GET request to Stripe to get the actual WebHook data. For details about Stripe WebHooks, see https://stripe.com/docs/webhooks.
InitializeReceiveVstsWebHooks ( this config ) : void

Initializes support for receiving WebHooks generated by Visual Studio Team Services. A sample WebHook URI is 'https://<host>/api/webhooks/incoming/vsts/{id}?code={code}'. For security reasons the WebHook URI must be an https URI and contain a 'code' query parameter with the same value as configured in the 'MS_WebHookReceiverSecret_VSTS' application setting, optionally using IDs to differentiate between multiple WebHooks, for example 'secret0, id1=secret1, id2=secret2'. The 'code' parameter must be between 32 and 128 characters long.
InitializeReceiveZendeskWebHooks ( this config ) : void

Initializes support for receiving Zendesk WebHooks. A sample WebHook URI is 'https://<host>/api/webhooks/incoming/zendesk/{id}?code=83699ec7c1d794c0c780e49a5c72972590571fd8'. For security reasons the WebHook URI must be an https URI and contain a 'code' query parameter with the same value as configured in the 'MS_WebHookReceiverSecret_Zendesk' application setting. The 'code' parameter must be between 32 and 128 characters long. For details about Zendesk WebHooks, see https://developer.zendesk.com/embeddables/docs/ios/push_notifications_webhook. For complete details about Zendesk APIs, see https://developer.zendesk.com/rest_api/docs/core/introduction.

Method Details

InitializeCustomWebHooksAzureQueueSender() public static method

Configures a Microsoft Azure Table Storage implementation of IWebHookStore which provides a persistent store for registered WebHooks used by the custom WebHooks module.
public static InitializeCustomWebHooksAzureQueueSender ( this config ) : void
config this The current config.
return void

InitializeCustomWebHooksAzureStorage() public static method

Configures a Microsoft Azure Table Storage implementation of IWebHookStore which provides a persistent store for registered WebHooks used by the custom WebHooks module. Using this initializer, the data will be encrypted using IDataProtector.
public static InitializeCustomWebHooksAzureStorage ( this config ) : void
config this The current config.
return void

InitializeCustomWebHooksAzureStorage() public static method

Configures a Microsoft Azure Table Storage implementation of IWebHookStore which provides a persistent store for registered WebHooks used by the custom WebHooks module.
public static InitializeCustomWebHooksAzureStorage ( this config, bool encryptData ) : void
config this The current config.
encryptData bool Indicates whether the data should be encrypted using while persisted.
return void

InitializeCustomWebHooksSqlStorage() public static method

Configures a Microsoft SQL Server Storage implementation of IWebHookStore which provides a persistent store for registered WebHooks used by the custom WebHooks module. Using this initializer, the data will be encrypted using IDataProtector.
public static InitializeCustomWebHooksSqlStorage ( this config ) : void
config this The current config.
return void

InitializeCustomWebHooksSqlStorage() public static method

Configures a Microsoft SQL Server Storage implementation of IWebHookStore which provides a persistent store for registered WebHooks used by the custom WebHooks module.
public static InitializeCustomWebHooksSqlStorage ( this config, bool encryptData ) : void
config this The current config.
encryptData bool Indicates whether the data should be encrypted using while persisted.
return void

InitializeReceiveGenericJsonWebHooks() public static method

Initializes support for receiving generic WebHooks containing valid JSON with no special validation logic or security requirements. This can for example be used to receive WebHooks from IFTTT's Maker Channel or a Zapier WebHooks Action. A sample WebHook URI is 'https://<host>/api/webhooks/incoming/genericjson/{id}?code=83699ec7c1d794c0c780e49a5c72972590571fd8'. For security reasons the WebHook URI must be an https URI and contain a 'code' query parameter with the same value as configured in the 'MS_WebHookReceiverSecret_GenericJson' application setting, optionally using IDs to differentiate between multiple WebHooks, for example 'secret0, id1=secret1, id2=secret2'. The 'code' parameter must be between 32 and 128 characters long. The URI may optionally include an 'action' query parameter which will serve as the WebHook action.
public static InitializeReceiveGenericJsonWebHooks ( this config ) : void
config this The current config.
return void

InitializeReceiveInstagramWebHooks() public static method

Initializes support for receiving Instagram WebHooks. Set the 'MS_WebHookReceiverSecret_Instagram' application setting to the application secrets, optionally using IDs to differentiate between multiple WebHooks, for example 'secret0, id1=secret1, id2=secret2'. The corresponding WebHook URI is of the form 'https://<host>/api/webhooks/incoming/instagram/{id}'. For details about Instagram WebHooks, see https://www.instagram.com/developer/subscriptions/.
public static InitializeReceiveInstagramWebHooks ( this config ) : void
config this The current config.
return void

InitializeReceiveMyGetWebHooks() public static method

Initializes support for receiving MyGet WebHooks. A sample WebHook URI is 'https://<host>/api/webhooks/incoming/myget/{id}?code=83699ec7c1d794c0c780e49a5c72972590571fd8'. For security reasons the WebHook URI must be an https URI and contain a 'code' query parameter with the same value as configured in the 'MS_WebHookReceiverSecret_MyGet' application setting. The 'code' parameter must be between 32 and 128 characters long. For details about MyGet WebHooks, see http://docs.myget.org/docs/reference/webhooks.
public static InitializeReceiveMyGetWebHooks ( this config ) : void
config this The current config.
return void

InitializeReceiveStripeDirectWebHooks() public static method

Initializes support for receiving Stripe WebHooks without any follow-up HTTP GET request to get the WebHook data. A sample WebHook URI is 'https://<host>/api/webhooks/incoming/stripe/{id}?code=83699ec7c1d794c0c780e49a5c72972590571fd8'. For security reasons the WebHook URI must be an https URI and contain a 'code' query parameter with the same value as configured in the 'MS_WebHookReceiverSecret_Stripe' application setting. The 'code' parameter must be between 32 and 128 characters long. For details about Stripe WebHooks, see https://stripe.com/docs/webhooks.
public static InitializeReceiveStripeDirectWebHooks ( this config ) : void
config this The current config.
return void

InitializeReceiveStripeWebHooks() public static method

Initializes support for receiving Stripe WebHooks. Set the 'MS_WebHookReceiverSecret_Stripe' application setting to the application key defined in Stripe. The corresponding WebHook URI is of the form 'https://<host>/api/webhooks/incoming/stripe/{id}'. As there is no code embedded in the URI, this mode will cause a follow-up HTTP GET request to Stripe to get the actual WebHook data. For details about Stripe WebHooks, see https://stripe.com/docs/webhooks.
public static InitializeReceiveStripeWebHooks ( this config ) : void
config this The current config.
return void

InitializeReceiveVstsWebHooks() public static method

Initializes support for receiving WebHooks generated by Visual Studio Team Services. A sample WebHook URI is 'https://<host>/api/webhooks/incoming/vsts/{id}?code={code}'. For security reasons the WebHook URI must be an https URI and contain a 'code' query parameter with the same value as configured in the 'MS_WebHookReceiverSecret_VSTS' application setting, optionally using IDs to differentiate between multiple WebHooks, for example 'secret0, id1=secret1, id2=secret2'. The 'code' parameter must be between 32 and 128 characters long.
public static InitializeReceiveVstsWebHooks ( this config ) : void
config this The current config.
return void

InitializeReceiveZendeskWebHooks() public static method

Initializes support for receiving Zendesk WebHooks. A sample WebHook URI is 'https://<host>/api/webhooks/incoming/zendesk/{id}?code=83699ec7c1d794c0c780e49a5c72972590571fd8'. For security reasons the WebHook URI must be an https URI and contain a 'code' query parameter with the same value as configured in the 'MS_WebHookReceiverSecret_Zendesk' application setting. The 'code' parameter must be between 32 and 128 characters long. For details about Zendesk WebHooks, see https://developer.zendesk.com/embeddables/docs/ios/push_notifications_webhook. For complete details about Zendesk APIs, see https://developer.zendesk.com/rest_api/docs/core/introduction.
public static InitializeReceiveZendeskWebHooks ( this config ) : void
config this The current config.
return void