You can monitor changes in your brand portal with the Amazon Simple Notification Service (AWS SNS). Whenever a change takes place in your portal this service will automatically notify another system, which means you don't have to continuously call our API to check for changes. Sit back and enjoy the ease of automatic SNS notifications.
The Amazon Simple Notification Service (AWS SNS) can be used to monitor changes in your brand portal and to push these events to other systems. Instead of having to continuously check our API for changes, an external system can be notified automatically via SNS in the event of a change. Currently the most used SNS notifications relate to media changes. A notification can be sent when a new asset or asset version is uploaded, when asset metadata is updated, but also the moment that assets are archived or deleted.
These notifications can be sent via email or SMS. Also it is possible to send them to AWS Lambda, Amazon SQS and a HTTP/S or API endpoint. The recipient receives the message in JSON format, which contains the information about the change (type of change, asset ID, time of change). An API call can then be made to check the actual change in the brand portal. Read more about AWS SNS here. If you are using an HTTPS endpoint, please review this AWS documentation to ensure your endpoint is set up to properly receive SNS Notifications.
Note
Bynder only supports standard SQS queues. SQS FIFO queues aren't supported.
In the table below you will find the SNS notifications that are currently supported. The name value of the SNS notification that will be sent to the external system is indicated in the Name column.
SNS notification |
Name |
---|---|
Media uploaded to Asset Bank. This also applies to each asset uploaded via the Mass Uploader |
asset_bank.media.create |
New version uploaded to existing media or change of active version |
asset_bank.media.updated |
Media set to archived |
asset_bank.media.archived |
Media deleted |
asset_bank.media.deleted |
Media metadata change (title, description or any metaproperty change) |
asset_bank.media.meta_updated |
New Creative Workflow job screated in the portal or via the API |
workflow.job.create |
You can find an example of an 'asset_bank.media.deleted' SNS notification in JSON format below, which follows the same formatting as returned via our API.
{ "media_id": "29***99D-BA27-***B-94E0F070DA***CAC", "media": { "userCreated": "Integrations Bynder", "limited": 0, "downloads": 0, "views": 0, "watermarked": 0, "mediaItems": [{ "version": 1, "active": 1, "dateCreated": "2019-12-10T10:35:14Z", "fileName": null, "id": "141***DD-E8C4-***B-A4CC949B1E4E0F27", "size": 3824, "height": 19, "width": 24, "focusPoint": { "x": 12.0, "y": 9.5 } }, { "version": 1, "active": 1, "dateCreated": "2019-12-10T10:35:14Z", "fileName": null, "id": "D463***C-EA27-4E9B-8B***2309B62BE87", "size": 1670, "height": 19, "width": 24, "focusPoint": { "x": 12.0, "y": 9.5 } }], "activeOriginalFocusPoint": { "x": 12.0, "y": 9.5 }, "archive": 0, "brandId": "8F7***4F-***8-4F32-902E2501A6433462", "copyright": "", "datePublished": "2019-12-10T10:35:13Z", "dateCreated": "2019-12-10T10:35:13Z", "description": "", "dateModified": "2020-02-07T16:30:16Z", "extension": ["png"], "fileSize": 1670, "height": 19, "id": "29***99D-BA27-***B-94E0F070DA5DECAC", "idHash": "55261de977ff5163", "isPublic": 0, "name": "test", "orientation": "landscape", "tags": [], "type": "image", "width": 24, "property_Country": ["France", "Germany", "Belgium"] } }
Provide your Customer Success Manager with the information listed below to set up SNS notifications for your brand portal.
-
Tell us which SNS notifications you would like to have enabled.
-
Tell us via which channel you would like the SNS notifications to be sent.
-
Provide us with the necessary details for that channel, such as the email address, phone number or API/HTTP/S endpoint etc.
-
(If applicable) Provide us with your SQS Amazon Resource Name (ARN) if you want SNS notifications to be sent to Amazon SQS.
-
Confirm the subscription in case you subscribed to email SNS notifications. You will receive an email from AWS to confirm your subscription.
-
(Optional) Implement a delay of a few seconds before consulting the API after receiving a SNS notification. SNS notifications are sent out right after assets were uploaded or modified. However, the changes may not immediately be available in the database and therefore not returned via the API. By making use of a small delay, you will receive the correct updated results via the API.
Caution
The only authentication method available at Bynder for HTTPS endpoint is 'Basic' HTTP Authentication. Please send a username and password to your Customer Success Manager and they can enable basic access authentication.
Comments
0 comments
Article is closed for comments.