Getting Started

How to Consume Event Management Service Api?

Before consuming any REST Api, it's crucial to understand its documentation. This typically includes details about the base URL, available endpoints, request methods (GET, POST, PUT, DELETE, etc.), required headers, query parameters, request payloads (for POST and PUT requests), and response formats. 💡 You can go through and learn Event Management Service API’s Specification here 👉 [Api Specification guide](https://docs-event-delivery.thredd.com/#section/Introduction).

1. Handle Responses

Once you make a request, you'll receive a response from the server. This response may contain the requested data (in the case of a successful request) or an error message (in the case of an unsuccessful request). You'll need to handle these responses appropriately in your code. Sample success response ``` { "status": "success", "response": { // response body and it will be changed based on endpoints } } ``` Sample error response ``` { "status": "error", "response": { "errorCode": "INVALID_EVENTCODE", "message": "Event Code is not valid." } } ```

2. MIME Types

All requests and responses are JSON-formatted. You must pass the standard JSON MIME type (application/Json).

3. Response Status Codes

Event Management Service Api uses the following response status codes | Http Status Code | Description | | ----------- | ----------- | | 200 | OK - The request has succeeded. The client can read the result of the request in the body and the headers of the response. | | 201 | Created - The resource was created successfully. The response may have information about the newly created resource. | | 204 | Deleted- The resource was deleted successfully. | | 400 | Bad Request - This is likely caused by validation errors; response body will provide further information. | | 404 | Not Found - The requested resource doesn’t exist. Please check documentation and the request. | | 500 | Internal Server Error - Response body may contain further information |

4. Error detail

Errors on Event Management Service Api will return a 4XX or a 5XX HTTP response code. Additional information about the error will be returned in the response body, in the following format ``` { "status": "error", "response": { "errorCode": "Error Code", "message": "Error Code Description" } } ```

5. Time zones

All timestamps are formatted as ISO8601 with time zone information. For Event Management Service Api calls that require date, we expect a string of the format YYYY-MM-DD, where an example would look like 2016-06-01. For Event Management Service Api calls that require datetime, we expect a string of the format yyyy-MM-ddddTHH:mm:ssZ, where an example would look like 2023-11-15T15:45:22Z. All times will be in UTC time zone. The format that we have documented for an endpoint cannot be changed and other formats for that endpoint are not supported.

6. Versioning

Event Management Service Api versioning scheme is implemented to manage changes and updates to Event Management Service Api while ensuring backward compatibility and smooth transitions for developers. Versioning is represented in the URL path of Api endpoints.

Versioning Format

Event Management Service Api versioning format follows the standard convention of including the version number in the URL path. For example: 💡 `https:////`

7. Best Practices

💡 NOTE: Following the time out of Event Management Service Api calls, allow more than 10 minutes for a subsequent Api call to create the same request.

Establishing Proper Processes Based on Documentation

Clients use Event Management Service Api endpoints as expected per [the documentation](https://docs-event-delivery.thredd.com/#section/Introduction).

How to use Webhooks related endpoints in Event Management Service Api?

To consume a webhook, you need to follow these steps:

Stage 1: Registering the Webhook

First, the clients must register the webhook using the webhook creation endpoint. This involves sending a request to the specified endpoint to create the webhook. The endpoint details and required parameters are provided in the [Api Specification guide](https://docs-event-delivery.thredd.com/#tag/Create-and-Manage-Webhooks/paths/~1api~1v1~1Webhooks/post).

Stage 2: Adding Event Subscriptions

Once the webhook is created, the user must call the add subscription endpoint to subscribe to specific events. This allows the webhook to receive notifications for those events. The endpoint details and required parameters are provided in the [Api Specification guide](https://docs-event-delivery.thredd.com/#tag/Manage-Event-Subscriptions/paths/~1api~1v1~1Webhooks~1%7Bwebhook_id%7D~1subscriptions/put). For more information about Thredd’s events. use 👉 [EDS Events](https://docs-event-delivery.thredd.com/#tag/Fraud). > *Checking the Webhook Heartbeat* > > *After the webhook is created and event subscriptions are added, users can check the heartbeat of the webhook URL to ensure it is active and receiving events. The heartbeat check helps verify the availability and responsiveness of the webhook endpoint. The endpoint details and required parameters are provided in the [documentation](https://docs-event-delivery.thredd.com/#tag/Create-and-Manage-Webhooks/paths/~1api~1v1~1Webhooks~1%7Bwebhook_id%7D~1heartbeat/get).*
💡 NOTE: > > - If any details were overlooked during creation, you have the option to rectify them by utilizing the endpoint 👉 [Update Webhook](https://docs-event-delivery.thredd.com/#tag/Create-and-Manage-Webhooks/paths/~1api~1v1~1Webhooks~1%7Bwebhook_id%7D/put). > - You can activate webhooks if they're inactive or suspend, using the endpoint 👉 [Update Webhook Status](https://docs-event-delivery.thredd.com/#tag/Create-and-Manage-Webhooks/paths/~1api~1v1~1Webhooks~1%7Bwebhook_id%7D~1status/put). > - You can view webhooks' details using the endpoints 👉 [List Webhook](https://docs-event-delivery.thredd.com/#tag/Create-and-Manage-Webhooks/paths/~1api~1v1~1Webhooks/get) and [Get Webhook](https://docs-event-delivery.thredd.com/#tag/Create-and-Manage-Webhooks/paths/~1api~1v1~1Webhooks~1%7Bwebhook_id%7D/get). > - You can delete registered events from a webhook using the endpoint 👉 [Delete event from Webhook](https://docs-event-delivery.thredd.com/#tag/Manage-Event-Subscriptions/paths/~1api~1v1~1Webhooks~1%7Bwebhook_id%7D~1subscriptions~1%7Bevent_code%7D/delete). > - You can view all registered events of a webhook using the endpoint 👉 [Get Events of a Webhook](https://docs-event-delivery.thredd.com/#tag/Manage-Event-Subscriptions/paths/~1api~1v1~1Webhooks~1%7Bwebhook_id%7D~1subscriptions/get).
---

How to use Notification related endpoints in Event Management Service Api?

Notifications enable your platform to receive updates about events as they occur. Currently, we have endpoints for tracking and managing notifications that we have sent. 💡 NOTE: > - For fetching notification details using Event Code, you can use the endpoint 👉 [Get Notification Details](https://docs-event-delivery.thredd.com/#tag/Manage-Notifications/paths/~1api~1v1~1Webhooks~1%7Bwebhook_id%7D~1events~1%7Bevent_code%7D~1notifications/get). > - For fetching notification details using Notification ID, you can use the endpoint 👉 [Get Notification Details](https://docs-event-delivery.thredd.com/#tag/Manage-Notifications/paths/~1api~1v1~1Webhooks~1%7Bwebhook_id%7D~1notifications/post). > - The vast majority of Webhooks are sent without any issues, but unfortunately a small number may error due to various reasons, from bad data to internet connectivity. Thus, you can use the endpoint 👉 [Get Undelivered Notifications](https://docs-event-delivery.thredd.com/#tag/Manage-Notifications/paths/~1api~1v1~1Webhooks~1%7Bwebhook_id%7D~1notifications~1undelivered/get) to track failed notifications. > - You can utilise this endpoint 👉 [Resend Notification ](https://docs-event-delivery.thredd.com/#tag/Manage-Notifications/paths/~1api~1v1~1Webhooks~1%7Bwebhook_id%7D~1resend/post) for resending existing notification.
---

Event Management Service Api Reference

| Version | [V1(Current Version) ](https://docs-event-delivery.thredd.com/#tag/Webhooks/operation/sendThreddNotificationFraudAcknolwedgement) | |-----------------------|--------------|
---

Code and Formats in Event Management Service

All the exceptions are encapsulated and return in format similar to the following code snippet ``` { "status": "error", "response": { "errorCode": "ERROR_CODE", "message": "Error code in descriptive" } } ```

Error Code Details

| Error Code | Error Description | | ----------- | ----------- | | TECHNICAL_ERROR | Technical error. | | UNABLE_TO_GET_RESULTS_FROM_DATABASE | Unable to get result from database. | | WEBHOOK_NOT_REGISTERED | Webhook not registered on Thredd. | | INVALID_WEBHOOK_ID | Invalid webhookId format. | | EMPTY_EVENTCODES | Event Codes cannot be empty. | | INVALID_EVENTCODE | Event Code should be valid. | | DUPLICATE_EVENTCODE | Event Code should be unique. | | SUBSCRIBED_EVENTCODE | Cannot subscribe to the same Event Code multiple times. | | DUPLICATE_EVENT_IN_EVENT_ARRAY | Please ensure there are no duplicate event codes in the event array. | | DUPLICATE_WEBHOOK | Found duplicate registration with same Client/Product | | INVALID_NOTIFICATION_ID | Invalid notificationId. | | IS_REQUIRED_NOTIFICATION_ID | Notification Id is required. | | NOTIFICATION_NOTFOUND | No notifications found. | | NOTIFICATION_BULK_GET_LIMIT_EXCEEDED | Cannot request notifications for more than 100 numbers at once. | | INVALID_DATE | Please provide a valid date in the format yyyy-MM-dd. | | UNDELIVERED_NOTIFICATIONS_NOTFOUND | No undelivered notifications found. | | FUTURE_DATE | Future dates are not permitted. | | CURRENT_STATUS_IS_SAME_AS_ENTERED_STATUS | Current webhook status is same as the entered status. | | EXCEEDS_MAXIMUM_CUSTOM_HEADER_LIMIT | Please ensure that the custom header count does not exceed three. | | WEBHOOK_IS_NOT_ACTIVE_IN_STATUS | The webhook is not marked as active. | | NOTIFICATION_RESEND_LIMIT_EXCEEDED | Cannot resend notifications for more than 25 numbers at once. | | DUPLICATE_NOTIFICATION_ID | Duplicate occurrence of NotificationId is not permitted. | | WEBHOOK_DETAILS_NOTFOUND | No webhook details were found. | | EVENTCODE_NOTFOUND | Event code not found within Thredd system. | | EVENTCODE_NOT_SUBSCRIBED | Event code not subscribed yet. | | EVENTCODE_ASSOCIATED_WITH_WEBHOOK | Unable to delete the event code since it is associated with a webhook. | | IS_REQUIRED_FROM_DATE | From date is required. |
---

Event Management Service Api Testing

### Testing Before testing Event Management Api, make sure the health check endpoint 👉 [Health Check ](https://docs-event-delivery.thredd.com/#tag/Healthcheck) return a 2xx status code. 💡 NOTE: > Adjust the base URL based on environment while keeping the endpoint path the same. #### 1. Register Webhook | Api Call | Description | URI | Response | | ----------- | ----------- |----------- | ----------- | | Register Webhook | Registers a new webhook for the client. |POST /v1/webhooks | HTTP: 201 Created | You can use below code for testing endpoint 👉 [Register Webhook](https://docs-event-delivery.thredd.com/#tag/Create-and-Manage-Webhooks/paths/~1api~1v1~1Webhooks/post). ``` using System.Text; using System.Text.Json; namespace RegisterWebhook { internal class Program { static async Task Main(string[] args) { await ConsumePostApiAsync().ConfigureAwait(false); } static async Task ConsumePostApiAsync() { try { var apiUrl = "https://localhost:44393/api/v1/Webhooks"; using var httpClient = new HttpClient(); // Prepare your POST data var postData = new { productId = 123456, events = null, webhookStatus = "active", config = new { url = "https://test.com/webhook", customHeaders = new Dictionary { {"header1", "value_1"}, {"header2", "value_2"}, {"header3", "value_3"} } } }; // Convert the object to JSON var json = JsonSerializer.Serialize(postData); // Prepare the HTTP request content var content = new StringContent(json, Encoding.UTF8, "application/json"); httpClient.DefaultRequestHeaders.Add("accept", "application/json"); // Send the POST request var response = await httpClient.PostAsync(apiUrl, content).ConfigureAwait(false); // Check if the request was successful (status code 2xx) if (response.IsSuccessStatusCode) { // Read the response content var responseData = await response.Content.ReadAsStringAsync().ConfigureAwait(false); Console.WriteLine("Response: " + responseData); } else { Console.WriteLine("Error: " + response.StatusCode); } } catch (Exception ex) { Console.WriteLine("Exception: " + ex.Message); } } } } ```
#### 2. Update Webhook | Api Call | Description | URI | Response | | ----------- | ----------- |----------- | ----------- | | Update Webhook | It can be used to update webhook details. |PUT /v1/webhooks/{webhook_id} | HTTP: 200 OK | You can use below code for testing endpoint 👉 [Update Webhook](https://docs-event-delivery.thredd.com/#tag/Create-and-Manage-Webhooks/paths/~1api~1v1~1Webhooks~1%7Bwebhook_id%7D/put). ``` using System; using System.Collections.Generic; using System.Net.Http; using System.Text; using System.Text.Json; using System.Threading.Tasks; class Program { static async Task Main(string[] args) { // URL of the REST endpoint string url = "https://localhost:44393/api/v1/webhooks/e16a3653-c739-4328-b5fa-51a2e10b3120"; // Prepare your POST data var putData = new { productId = 111, events = new int[] { 101 }, config = new { url = "https://test.com/webhook", customHeaders = new Dictionary { {"header1", "test1"}, {"header2", "test2"}, {"header3", "test3"} } } }; // Convert the object to JSON var jsonPayload = JsonSerializer.Serialize(putData); // Create a HttpClient instance using (HttpClient client = new HttpClient()) { // Add headers if needed client.DefaultRequestHeaders.Add("accept", "application/json"); // Prepare the request content var content = new StringContent(jsonPayload, Encoding.UTF8, "application/json"); // Send the HTTP PUT request HttpResponseMessage response = await client.PutAsync(url, content); // Check if the request was successful if (response.IsSuccessStatusCode) { var responseData = await response.Content.ReadAsStringAsync().ConfigureAwait(false); Console.WriteLine("Response: " + responseData); } else { Console.WriteLine($"Failed to update. Status code: {response.StatusCode}"); // You can handle error cases here } } } } ```
#### 3. Update Webhook Status | Api Call | Description | URI | Response | | ----------- | ----------- |----------- | ----------- | | Update status of a Webhook | It can be used to update webhook details. |PUT /v1/webhooks/{webhook_id}/status | HTTP: 200 OK | You can use below code for testing endpoint 👉 [Update Webhook Status](https://docs-event-delivery.thredd.com/#tag/Create-and-Manage-Webhooks/paths/~1api~1v1~1Webhooks~1%7Bwebhook_id%7D~1status/put). ``` using System; using System.Collections.Generic; using System.Net.Http; using System.Text; using System.Text.Json; using System.Threading.Tasks; class Program { static async Task Main(string[] args) { // URL of the REST endpoint string url = "https://localhost:44393/api/v1/webhooks/e16a3653-c739-4328-b5fa-51a2e10b3120/status"; // Prepare your POST data var putData = new { webhookStatus = "inactive" }; // Convert the object to JSON var jsonPayload = JsonSerializer.Serialize(putData); // Create a HttpClient instance using (HttpClient client = new HttpClient()) { // Add headers if needed client.DefaultRequestHeaders.Add("accept", "application/json"); // Prepare the request content var content = new StringContent(jsonPayload, Encoding.UTF8, "application/json"); // Send the HTTP PUT request HttpResponseMessage response = await client.PutAsync(url, content); // Check if the request was successful if (response.IsSuccessStatusCode) { var responseData = await response.Content.ReadAsStringAsync().ConfigureAwait(false); Console.WriteLine("Response: " + responseData); } else { Console.WriteLine($"Failed to update. Status code: {response.StatusCode}"); // You can handle error cases here } } } } ```
#### 4. Get Webhook | Api Call | Description | URI | Response | | ----------- | ----------- |----------- | ----------- | | Get Webhook | It can be used to get webhook details. |GET /v1/webhooks/{webhook_id} | HTTP: 200 OK | You can use below code for testing endpoint 👉 [ Get Webhook](https://docs-event-delivery.thredd.com/#tag/Create-and-Manage-Webhooks/paths/~1api~1v1~1Webhooks~1%7Bwebhook_id%7D/get). ``` using System; using System.Net.Http; using System.Threading.Tasks; class Program { static async Task Main(string[] args) { // URL of the GET endpoint string url = "https://localhost:44393/api/v1/webhooks/e16a3653-c739-4328-b5fa-51a2e10b3120"; // Create a HttpClient instance using (HttpClient client = new HttpClient()) { // Add headers if needed client.DefaultRequestHeaders.Add("accept", "application/json"); // Send the HTTP GET request HttpResponseMessage response = await client.GetAsync(url); // Check if the request was successful if (response.IsSuccessStatusCode) { // Read the response content as a string string responseData = await response.Content.ReadAsStringAsync(); // Do something with the response data Console.WriteLine("Response Data:"); Console.WriteLine(responseData); } else { Console.WriteLine($"Failed to retrieve data. Status code: {response.StatusCode}"); // You can handle error cases here } } } } ```
#### 5. List Webhooks | Api Call | Description | URI | Response | | ----------- | ----------- |----------- | ----------- | | List Webhooks | It can be used to list all webhooks for a client. |GET /v1/webhooks | HTTP: 200 OK | You can use below code for testing endpoint 👉 [ List Webhooks](https://docs-event-delivery.thredd.com/#tag/Create-and-Manage-Webhooks/paths/~1api~1v1~1Webhooks/get). ``` using System; using System.Net.Http; using System.Threading.Tasks; class Program { static async Task Main(string[] args) { // URL of the GET endpoint string url = "https://localhost:44393/api/v1/webhooks"; // Create a HttpClient instance using (HttpClient client = new HttpClient()) { // Add headers if needed client.DefaultRequestHeaders.Add("accept", "application/json"); // Send the HTTP GET request HttpResponseMessage response = await client.GetAsync(url); // Check if the request was successful if (response.IsSuccessStatusCode) { // Read the response content as a string string responseData = await response.Content.ReadAsStringAsync(); // Do something with the response data Console.WriteLine("Response Data:"); Console.WriteLine(responseData); } else { Console.WriteLine($"Failed to retrieve data. Status code: {response.StatusCode}"); // You can handle error cases here } } } } ```
#### 6. Get Heartbeat | Api Call | Description | URI | Response | | ----------- | ----------- |----------- | ----------- | | Get Heartbeat | It can be used to heartbeat of the webhook. |GET /api/v1/Webhooks/{webhook_id}/heartbeat | HTTP: 200 OK | You can use below code for testing endpoint 👉 [Check Heartbeat of the Webhook](https://docs-event-delivery.thredd.com/#tag/Create-and-Manage-Webhooks/paths/~1api~1v1~1Webhooks~1%7Bwebhook_id%7D~1heartbeat/get). ``` using System; using System.Net.Http; using System.Threading.Tasks; class Program { static async Task Main(string[] args) { // URL of the GET endpoint string url = "https://localhost:44393/api/v1/webhooks/e16a3653-c739-4328-b5fa-51a2e10b3120/heartbeat"; // Create a HttpClient instance using (HttpClient client = new HttpClient()) { // Add headers if needed client.DefaultRequestHeaders.Add("accept", "application/json"); // Send the HTTP GET request HttpResponseMessage response = await client.GetAsync(url); // Check if the request was successful if (response.IsSuccessStatusCode) { // Read the response content as a string string responseData = await response.Content.ReadAsStringAsync(); // Do something with the response data Console.WriteLine("Response Data:"); Console.WriteLine(responseData); } else { Console.WriteLine($"Failed to retrieve data. Status code: {response.StatusCode}"); // You can handle error cases here } } } } ```
#### 7. Add event subscriptions | Api Call | Description | URI | Response | | ----------- | ----------- |----------- | ----------- | | Add event subscriptions | It can be used to add event subscription to existing webhook. |PUT /v1/webhooks/{webhook_id}/subscriptions | HTTP: 200 OK | You can use below code for testing endpoint 👉 [Add Event Subscription](https://docs-event-delivery.thredd.com/#tag/Manage-Event-Subscriptions/paths/~1api~1v1~1Webhooks~1%7Bwebhook_id%7D~1subscriptions/put). ``` using System.Text; using System.Text.Json; class Program { static async Task Main(string[] args) { // URL of the REST endpoint string url = "https://localhost:44393/api/v1/webhooks/e16a3653-c739-4328-b5fa-51a2e10b3120/subscriptions"; // Prepare your POST data var putData = new { events = new int[] { 102 } }; // Convert the object to JSON var jsonPayload = JsonSerializer.Serialize(putData); // Create a HttpClient instance using (HttpClient client = new HttpClient()) { // Add headers if needed client.DefaultRequestHeaders.Add("accept", "application/json"); // Prepare the request content var content = new StringContent(jsonPayload, Encoding.UTF8, "application/json"); // Send the HTTP PUT request HttpResponseMessage response = await client.PutAsync(url, content); // Check if the request was successful if (response.IsSuccessStatusCode) { var responseData = await response.Content.ReadAsStringAsync().ConfigureAwait(false); Console.WriteLine("Response: " + responseData); } else { Console.WriteLine($"Failed to update. Status code: {response.StatusCode}"); // You can handle error cases here } } } } ```
#### 8. Get event subscriptions | Api Call | Description | URI | Response | | ----------- | ----------- |----------- | ----------- | | Get event subscriptions | It can be used to get event subscription of a webhook. |GET /v1/webhooks/{webhook_id}/subscriptions | HTTP: 200 OK | You can use below code for testing endpoint 👉 [Get Event Subscriptions](https://docs-event-delivery.thredd.com/#tag/Manage-Event-Subscriptions/paths/~1api~1v1~1Webhooks~1%7Bwebhook_id%7D~1subscriptions/get). ``` using System; using System.Net.Http; using System.Threading.Tasks; class Program { static async Task Main(string[] args) { // URL of the GET endpoint string url = "https://localhost:44393/api/v1/webhooks/e16a3653-c739-4328-b5fa-51a2e10b3120/subscriptions"; // Create a HttpClient instance using (HttpClient client = new HttpClient()) { // Add headers if needed client.DefaultRequestHeaders.Add("accept", "application/json"); // Send the HTTP GET request HttpResponseMessage response = await client.GetAsync(url); // Check if the request was successful if (response.IsSuccessStatusCode) { // Read the response content as a string string responseData = await response.Content.ReadAsStringAsync(); // Do something with the response data Console.WriteLine("Response Data:"); Console.WriteLine(responseData); } else { Console.WriteLine($"Failed to retrieve data. Status code: {response.StatusCode}"); // You can handle error cases here } } } } ```
#### 9. Delete event subscription | Api Call | Description | URI | Response | | ----------- | ----------- |----------- | ----------- | | Delete event subscriptions | It can be used to delete event subscription from a webhook. |DELETE /v1/webhooks/{webhook_id}/subscriptions/{event_code} | HTTP: 204 No Content | You can use below code for testing endpoint 👉 [Delete Event Subscription](https://docs-event-delivery.thredd.com/#tag/Manage-Event-Subscriptions/paths/~1api~1v1~1Webhooks~1%7Bwebhook_id%7D~1subscriptions~1%7Bevent_code%7D/delete). ``` using System; using System.Net.Http; using System.Threading.Tasks; class Program { static async Task Main(string[] args) { // URL of the DELETE endpoint string url = "https://localhost:44393/api/v1/webhooks/e16a3653-c739-4328-b5fa-51a2e10b3120/subscriptions/102"; // Create a HttpClient instance using (HttpClient client = new HttpClient()) { //Add headers if needed client.DefaultRequestHeaders.Add("accept", "application/json"); // Send the HTTP DELETE request HttpResponseMessage response = await client.DeleteAsync(url); // Check if the request was successful if (response.IsSuccessStatusCode) { Console.WriteLine("DELETE request successful."); // You can handle success cases here } else { Console.WriteLine($"Failed to delete resource. Status code: {response.StatusCode}"); // You can handle error cases here } } } } ```
#### 10. Get Notification by IDs | Api Call | Description | URI | Response | | ----------- | ----------- |----------- | ----------- | | Get Notification details | It can be used to get notification details by Ids |POST /v1/webhooks/{webhook_id}/notifications | HTTP: 200 OK | You can use below code for testing endpoint 👉 [Get Notification by IDs](https://docs-event-delivery.thredd.com/#tag/Manage-Notifications/paths/~1api~1v1~1Webhooks~1%7Bwebhook_id%7D~1notifications/post). ``` using System; using System.Collections.Generic; using System.Net.Http; using System.Text; using System.Text.Json; using System.Threading.Tasks; namespace Notification { internal class Program { static async Task Main(string[] args) { await ConsumePostApiAsync().ConfigureAwait(false); } static async Task ConsumePostApiAsync() { try { var apiUrl = "https://localhost:44393/api/v1/webhooks/e16a3653-c739-4328-b5fa-51a2e10b3120/notifications"; using var httpClient = new HttpClient(); // Prepare your POST data var postData = new { notificationIds = new string[] { "b94c0c08-409f-4ce9-8499-66e3406c000c" } }; // Convert the object to JSON var json = JsonSerializer.Serialize(postData); // Prepare the HTTP request content var content = new StringContent(json, Encoding.UTF8, "application/json"); httpClient.DefaultRequestHeaders.Add("accept", "application/json"); // Send the POST request var response = await httpClient.PostAsync(apiUrl, content).ConfigureAwait(false); // Check if the request was successful (status code 2xx) if (response.IsSuccessStatusCode) { // Read the response content var responseData = await response.Content.ReadAsStringAsync().ConfigureAwait(false); Console.WriteLine("Response: " + responseData); } else { Console.WriteLine("Error: " + response.StatusCode); } } catch (Exception ex) { Console.WriteLine("Exception: " + ex.Message); } } } } ```
#### 11. Retrieve notifications by event code | Api Call | Description | URI | Response | | ----------- | ----------- |----------- | ----------- | | Retrieve notifications by event code | It can be used to get notification details for Event Code. |GET /v1/webhooks/{webhook_id}/events/{event_code}/notifications?from=date | HTTP: 200 OK | You can use below code for testing endpoint 👉 [Retrieve Notifications by Event Code](https://docs-event-delivery.thredd.com/#tag/Manage-Notifications/paths/~1api~1v1~1Webhooks~1%7Bwebhook_id%7D~1events~1%7Bevent_code%7D~1notifications/get). ``` using System; using System.Net.Http; using System.Threading.Tasks; class Program { static async Task Main(string[] args) { // Base URL of the GET endpoint string baseUrl = "https://localhost:44393/api/v1/webhooks/e16a3653-c739-4328-b5fa-51a2e10b3120/events/101/notifications"; // Date parameter in yyyy-mm-dd format string dateString = "2024-04-30"; // Create the complete URL with the query string string url = $"{baseUrl}?from={dateString}"; // Create a HttpClient instance using (HttpClient client = new HttpClient()) { // Add headers if needed client.DefaultRequestHeaders.Add("accept", "application/json"); // Send the HTTP GET request HttpResponseMessage response = await client.GetAsync(url); // Check if the request was successful if (response.IsSuccessStatusCode) { // Read the response content as a string string responseData = await response.Content.ReadAsStringAsync(); // Do something with the response data Console.WriteLine("Response Data:"); Console.WriteLine(responseData); } else { Console.WriteLine($"Failed to retrieve data. Status code: {response.StatusCode}"); // You can handle error cases here } } } ```
#### 12. Retrieve undelivered notifications | Api Call | Description | URI | Response | | ----------- | ----------- |----------- | ----------- | | Retrieve undelivered notifications | It can be used to get undelivered notification. |GET /api/v1/Webhooks/{webhook_id}/notifications/undelivere | HTTP: 200 OK | You can use below code for testing endpoint 👉 [Retrieve undelivered notifications](https://docs-event-delivery.thredd.com/#tag/Manage-Notifications/paths/~1api~1v1~1Webhooks~1%7Bwebhook_id%7D~1notifications~1undelivered/get). ``` using System; using System.Net.Http; using System.Threading.Tasks; class Program { static async Task Main(string[] args) { // Base URL of the GET endpoint string baseUrl = "https://localhost:44393/api/v1/webhooks/e16a3653-c739-4328-b5fa-51a2e10b3120/notifications/undelivered"; // Date parameter in yyyy-mm-dd format string dateString = "2024-04-30"; // Create the complete URL with the query string string url = $"{baseUrl}?from={dateString}"; // Create a HttpClient instance using (HttpClient client = new HttpClient()) { // Add headers if needed client.DefaultRequestHeaders.Add("accept", "application/json"); // Send the HTTP GET request HttpResponseMessage response = await client.GetAsync(url); // Check if the request was successful if (response.IsSuccessStatusCode) { // Read the response content as a string string responseData = await response.Content.ReadAsStringAsync(); // Do something with the response data Console.WriteLine("Response Data:"); Console.WriteLine(responseData); } else { Console.WriteLine($"Failed to retrieve data. Status code: {response.StatusCode}"); // You can handle error cases here } } } } ```
#### 13. Resend event notifications | Api Call | Description | URI | Response | | ----------- | ----------- |----------- | ----------- | | Resend event notifications | It can be used to resend notification. |POST /api/v1/Webhooks/{webhook_id}/resend | HTTP: 200 OK | You can use below code for testing endpoint 👉 [Resend event notifications](https://docs-event-delivery.thredd.com/#tag/Manage-Notifications/paths/~1api~1v1~1Webhooks~1%7Bwebhook_id%7D~1resend/post). ``` using System; using System.Collections.Generic; using System.Net.Http; using System.Text; using System.Text.Json; using System.Threading.Tasks; namespace Notification { internal class Program { static async Task Main(string[] args) { await ConsumePostApiAsync().ConfigureAwait(false); } static async Task ConsumePostApiAsync() { try { var apiUrl = "https://localhost:44393/api/v1/Webhooks/e16a3653-c739-4328-b5fa-51a2e10b3120/resend"; using var httpClient = new HttpClient(); // Prepare your POST data var postData = new { notificationIds = new string[] { "b94c0c08-409f-4ce9-8499-66e3406c000c" } }; // Convert the object to JSON var json = JsonSerializer.Serialize(postData); // Prepare the HTTP request content var content = new StringContent(json, Encoding.UTF8, "application/json"); httpClient.DefaultRequestHeaders.Add("accept", "application/json"); // Send the POST request var response = await httpClient.PostAsync(apiUrl, content).ConfigureAwait(false); // Check if the request was successful (status code 2xx) if (response.IsSuccessStatusCode) { // Read the response content var responseData = await response.Content.ReadAsStringAsync().ConfigureAwait(false); Console.WriteLine("Response: " + responseData); } else { Console.WriteLine("Error: " + response.StatusCode); } } catch (Exception ex) { Console.WriteLine("Exception: " + ex.Message); } } } } ```
---