github.com/launchdarkly/api-client-go@v5.3.0+incompatible/docs/WebhooksApi.md (about)

     1  # \WebhooksApi
     2  
     3  All URIs are relative to *https://app.launchdarkly.com/api/v2*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**DeleteWebhook**](WebhooksApi.md#DeleteWebhook) | **Delete** /webhooks/{resourceId} | Delete a webhook by ID.
     8  [**GetWebhook**](WebhooksApi.md#GetWebhook) | **Get** /webhooks/{resourceId} | Get a webhook by ID.
     9  [**GetWebhooks**](WebhooksApi.md#GetWebhooks) | **Get** /webhooks | Fetch a list of all webhooks.
    10  [**PatchWebhook**](WebhooksApi.md#PatchWebhook) | **Patch** /webhooks/{resourceId} | Modify a webhook by ID.
    11  [**PostWebhook**](WebhooksApi.md#PostWebhook) | **Post** /webhooks | Create a webhook.
    12  
    13  
    14  # **DeleteWebhook**
    15  > DeleteWebhook(ctx, resourceId)
    16  Delete a webhook by ID.
    17  
    18  ### Required Parameters
    19  
    20  Name | Type | Description  | Notes
    21  ------------- | ------------- | ------------- | -------------
    22   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    23    **resourceId** | **string**| The resource ID. | 
    24  
    25  ### Return type
    26  
    27   (empty response body)
    28  
    29  ### Authorization
    30  
    31  [Token](../README.md#Token)
    32  
    33  ### HTTP request headers
    34  
    35   - **Content-Type**: application/json
    36   - **Accept**: application/json
    37  
    38  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    39  
    40  # **GetWebhook**
    41  > Webhook GetWebhook(ctx, resourceId)
    42  Get a webhook by ID.
    43  
    44  ### Required Parameters
    45  
    46  Name | Type | Description  | Notes
    47  ------------- | ------------- | ------------- | -------------
    48   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    49    **resourceId** | **string**| The resource ID. | 
    50  
    51  ### Return type
    52  
    53  [**Webhook**](Webhook.md)
    54  
    55  ### Authorization
    56  
    57  [Token](../README.md#Token)
    58  
    59  ### HTTP request headers
    60  
    61   - **Content-Type**: application/json
    62   - **Accept**: application/json
    63  
    64  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    65  
    66  # **GetWebhooks**
    67  > Webhooks GetWebhooks(ctx, )
    68  Fetch a list of all webhooks.
    69  
    70  ### Required Parameters
    71  This endpoint does not need any parameter.
    72  
    73  ### Return type
    74  
    75  [**Webhooks**](Webhooks.md)
    76  
    77  ### Authorization
    78  
    79  [Token](../README.md#Token)
    80  
    81  ### HTTP request headers
    82  
    83   - **Content-Type**: application/json
    84   - **Accept**: application/json
    85  
    86  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    87  
    88  # **PatchWebhook**
    89  > Webhook PatchWebhook(ctx, resourceId, patchDelta)
    90  Modify a webhook by ID.
    91  
    92  ### Required Parameters
    93  
    94  Name | Type | Description  | Notes
    95  ------------- | ------------- | ------------- | -------------
    96   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    97    **resourceId** | **string**| The resource ID. | 
    98    **patchDelta** | [**[]PatchOperation**](PatchOperation.md)| Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/' | 
    99  
   100  ### Return type
   101  
   102  [**Webhook**](Webhook.md)
   103  
   104  ### Authorization
   105  
   106  [Token](../README.md#Token)
   107  
   108  ### HTTP request headers
   109  
   110   - **Content-Type**: application/json
   111   - **Accept**: application/json
   112  
   113  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   114  
   115  # **PostWebhook**
   116  > Webhook PostWebhook(ctx, webhookBody)
   117  Create a webhook.
   118  
   119  ### Required Parameters
   120  
   121  Name | Type | Description  | Notes
   122  ------------- | ------------- | ------------- | -------------
   123   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   124    **webhookBody** | [**WebhookBody**](WebhookBody.md)| New webhook. | 
   125  
   126  ### Return type
   127  
   128  [**Webhook**](Webhook.md)
   129  
   130  ### Authorization
   131  
   132  [Token](../README.md#Token)
   133  
   134  ### HTTP request headers
   135  
   136   - **Content-Type**: application/json
   137   - **Accept**: application/json
   138  
   139  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   140