To receive notifications, you need to configure a WebHook Notification Channel for your application. Notifications such as ImageGenerationProgress and ImageGenerationTaskCompleted will be sent to the configured endpoint.
Setting Up a WebHook Listener
Below is an example implementation of a WebHook listener to receive and parse notifications.
Example Listener (C#)
/// <summary>
/// Listens to the AdCreative API webhook notifications.
/// </summary>
[HttpPost, AllowAnonymous]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status400BadRequest)]
[ProducesResponseType(StatusCodes.Status500InternalServerError)]
public async Task<IActionResult> WebhookListener()
{
using var reader = new StreamReader(Request.Body);
var jsonBody = await reader.ReadToEndAsync();
if (string.IsNullOrEmpty(jsonBody))
{
_logger.LogError("Invalid WebHook request body.");
return BadRequest("Invalid WebHook request body.");
}
var message = UnionConverter<INotificationMessage>.Deserialize(jsonBody);
switch (message)
{
case ImageGenerationProgress progress:
_logger.LogInformation("Image Generation Progress received for User: {0}", progress.UserId);
// Process Progress
break;
case ImageGenerationTaskCompleted taskCompleted:
_logger.LogInformation("Image Generation Task Completed for User: {0}", taskCompleted.UserId);
// Process Task Completion
break;
case ImageUpscalingProgress progress:
_logger.LogInformation("Image Upscaling Progress received for User: {0}", progress.UserId);
// Process Progress
break;
case ImageUpscalingTaskCompleted taskCompleted:
_logger.LogInformation("Image Upscaling Task Completed for User: {0}", taskCompleted.UserId);
// Process Task Completion
break;
case ImageFaceEnhancingProgress progress:
_logger.LogInformation("Image Face Enhancing Progress received for User: {0}", progress.UserId);
// Process Progress
break;
case ImageFaceEnhancingTaskCompleted taskCompleted:
_logger.LogInformation("Image Face Enhancing Task Completed for User: {0}", taskCompleted.UserId);
// Process Task Completion
break;
case ImageBackgroundRemovingProgress progress:
_logger.LogInformation("Image Background Removing Progress received for User: {0}", progress.UserId);
// Process Progress
break;
case ImageBackgroundRemovingTaskCompleted taskCompleted:
_logger.LogInformation("Image Background Removing Task Completed for User: {0}", taskCompleted.UserId);
// Process Task Completion
break;
case ImageStockGenerationProgress progress:
_logger.LogInformation("Image Stock Generation Progress received for User: {0}", progress.UserId);
// Process Progress
break;
case ImageStockGenerationTaskCompleted taskCompleted:
_logger.LogInformation("Image Stock Generation Task Completed for User: {0}", taskCompleted.UserId);
// Process Task Completion
break;
default:
_logger.LogWarning("Unknown notification type received.");
return BadRequest("Unknown notification type.");
}
return Ok();
}
Notification Message Types
1. ImageGenerationTaskCompleted
Represents a notification sent when an image generation task is completed.
