github.com/twilio/twilio-go@v1.20.1/rest/conversations/v1/docs/ConversationsWebhooksApi.md (about)

     1  # ConversationsWebhooksApi
     2  
     3  All URIs are relative to *https://conversations.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateConversationScopedWebhook**](ConversationsWebhooksApi.md#CreateConversationScopedWebhook) | **Post** /v1/Conversations/{ConversationSid}/Webhooks | 
     8  [**DeleteConversationScopedWebhook**](ConversationsWebhooksApi.md#DeleteConversationScopedWebhook) | **Delete** /v1/Conversations/{ConversationSid}/Webhooks/{Sid} | 
     9  [**FetchConversationScopedWebhook**](ConversationsWebhooksApi.md#FetchConversationScopedWebhook) | **Get** /v1/Conversations/{ConversationSid}/Webhooks/{Sid} | 
    10  [**ListConversationScopedWebhook**](ConversationsWebhooksApi.md#ListConversationScopedWebhook) | **Get** /v1/Conversations/{ConversationSid}/Webhooks | 
    11  [**UpdateConversationScopedWebhook**](ConversationsWebhooksApi.md#UpdateConversationScopedWebhook) | **Post** /v1/Conversations/{ConversationSid}/Webhooks/{Sid} | 
    12  
    13  
    14  
    15  ## CreateConversationScopedWebhook
    16  
    17  > ConversationsV1ConversationScopedWebhook CreateConversationScopedWebhook(ctx, ConversationSidoptional)
    18  
    19  
    20  
    21  Create a new webhook scoped to the conversation
    22  
    23  ### Path Parameters
    24  
    25  
    26  Name | Type | Description
    27  ------------- | ------------- | -------------
    28  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    29  **ConversationSid** | **string** | The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook.
    30  
    31  ### Other Parameters
    32  
    33  Other parameters are passed through a pointer to a CreateConversationScopedWebhookParams struct
    34  
    35  
    36  Name | Type | Description
    37  ------------- | ------------- | -------------
    38  **Target** | **string** | 
    39  **ConfigurationUrl** | **string** | The absolute url the webhook request should be sent to.
    40  **ConfigurationMethod** | **string** | 
    41  **ConfigurationFilters** | **[]string** | The list of events, firing webhook event for this Conversation.
    42  **ConfigurationTriggers** | **[]string** | The list of keywords, firing webhook event for this Conversation.
    43  **ConfigurationFlowSid** | **string** | The studio flow SID, where the webhook should be sent to.
    44  **ConfigurationReplayAfter** | **int** | The message index for which and it's successors the webhook will be replayed. Not set by default
    45  
    46  ### Return type
    47  
    48  [**ConversationsV1ConversationScopedWebhook**](ConversationsV1ConversationScopedWebhook.md)
    49  
    50  ### Authorization
    51  
    52  [accountSid_authToken](../README.md#accountSid_authToken)
    53  
    54  ### HTTP request headers
    55  
    56  - **Content-Type**: application/x-www-form-urlencoded
    57  - **Accept**: application/json
    58  
    59  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    60  [[Back to Model list]](../README.md#documentation-for-models)
    61  [[Back to README]](../README.md)
    62  
    63  
    64  ## DeleteConversationScopedWebhook
    65  
    66  > DeleteConversationScopedWebhook(ctx, ConversationSidSid)
    67  
    68  
    69  
    70  Remove an existing webhook scoped to the conversation
    71  
    72  ### Path Parameters
    73  
    74  
    75  Name | Type | Description
    76  ------------- | ------------- | -------------
    77  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    78  **ConversationSid** | **string** | The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook.
    79  **Sid** | **string** | A 34 character string that uniquely identifies this resource.
    80  
    81  ### Other Parameters
    82  
    83  Other parameters are passed through a pointer to a DeleteConversationScopedWebhookParams struct
    84  
    85  
    86  Name | Type | Description
    87  ------------- | ------------- | -------------
    88  
    89  ### Return type
    90  
    91   (empty response body)
    92  
    93  ### Authorization
    94  
    95  [accountSid_authToken](../README.md#accountSid_authToken)
    96  
    97  ### HTTP request headers
    98  
    99  - **Content-Type**: Not defined
   100  - **Accept**: Not defined
   101  
   102  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   103  [[Back to Model list]](../README.md#documentation-for-models)
   104  [[Back to README]](../README.md)
   105  
   106  
   107  ## FetchConversationScopedWebhook
   108  
   109  > ConversationsV1ConversationScopedWebhook FetchConversationScopedWebhook(ctx, ConversationSidSid)
   110  
   111  
   112  
   113  Fetch the configuration of a conversation-scoped webhook
   114  
   115  ### Path Parameters
   116  
   117  
   118  Name | Type | Description
   119  ------------- | ------------- | -------------
   120  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   121  **ConversationSid** | **string** | The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook.
   122  **Sid** | **string** | A 34 character string that uniquely identifies this resource.
   123  
   124  ### Other Parameters
   125  
   126  Other parameters are passed through a pointer to a FetchConversationScopedWebhookParams struct
   127  
   128  
   129  Name | Type | Description
   130  ------------- | ------------- | -------------
   131  
   132  ### Return type
   133  
   134  [**ConversationsV1ConversationScopedWebhook**](ConversationsV1ConversationScopedWebhook.md)
   135  
   136  ### Authorization
   137  
   138  [accountSid_authToken](../README.md#accountSid_authToken)
   139  
   140  ### HTTP request headers
   141  
   142  - **Content-Type**: Not defined
   143  - **Accept**: application/json
   144  
   145  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   146  [[Back to Model list]](../README.md#documentation-for-models)
   147  [[Back to README]](../README.md)
   148  
   149  
   150  ## ListConversationScopedWebhook
   151  
   152  > []ConversationsV1ConversationScopedWebhook ListConversationScopedWebhook(ctx, ConversationSidoptional)
   153  
   154  
   155  
   156  Retrieve a list of all webhooks scoped to the conversation
   157  
   158  ### Path Parameters
   159  
   160  
   161  Name | Type | Description
   162  ------------- | ------------- | -------------
   163  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   164  **ConversationSid** | **string** | The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook.
   165  
   166  ### Other Parameters
   167  
   168  Other parameters are passed through a pointer to a ListConversationScopedWebhookParams struct
   169  
   170  
   171  Name | Type | Description
   172  ------------- | ------------- | -------------
   173  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   174  **Limit** | **int** | Max number of records to return.
   175  
   176  ### Return type
   177  
   178  [**[]ConversationsV1ConversationScopedWebhook**](ConversationsV1ConversationScopedWebhook.md)
   179  
   180  ### Authorization
   181  
   182  [accountSid_authToken](../README.md#accountSid_authToken)
   183  
   184  ### HTTP request headers
   185  
   186  - **Content-Type**: Not defined
   187  - **Accept**: application/json
   188  
   189  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   190  [[Back to Model list]](../README.md#documentation-for-models)
   191  [[Back to README]](../README.md)
   192  
   193  
   194  ## UpdateConversationScopedWebhook
   195  
   196  > ConversationsV1ConversationScopedWebhook UpdateConversationScopedWebhook(ctx, ConversationSidSidoptional)
   197  
   198  
   199  
   200  Update an existing conversation-scoped webhook
   201  
   202  ### Path Parameters
   203  
   204  
   205  Name | Type | Description
   206  ------------- | ------------- | -------------
   207  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   208  **ConversationSid** | **string** | The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook.
   209  **Sid** | **string** | A 34 character string that uniquely identifies this resource.
   210  
   211  ### Other Parameters
   212  
   213  Other parameters are passed through a pointer to a UpdateConversationScopedWebhookParams struct
   214  
   215  
   216  Name | Type | Description
   217  ------------- | ------------- | -------------
   218  **ConfigurationUrl** | **string** | The absolute url the webhook request should be sent to.
   219  **ConfigurationMethod** | **string** | 
   220  **ConfigurationFilters** | **[]string** | The list of events, firing webhook event for this Conversation.
   221  **ConfigurationTriggers** | **[]string** | The list of keywords, firing webhook event for this Conversation.
   222  **ConfigurationFlowSid** | **string** | The studio flow SID, where the webhook should be sent to.
   223  
   224  ### Return type
   225  
   226  [**ConversationsV1ConversationScopedWebhook**](ConversationsV1ConversationScopedWebhook.md)
   227  
   228  ### Authorization
   229  
   230  [accountSid_authToken](../README.md#accountSid_authToken)
   231  
   232  ### HTTP request headers
   233  
   234  - **Content-Type**: application/x-www-form-urlencoded
   235  - **Accept**: application/json
   236  
   237  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   238  [[Back to Model list]](../README.md#documentation-for-models)
   239  [[Back to README]](../README.md)
   240