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

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