Sign in

v1

latestOpenAPI 3.1.02026-07-2419782400.4 KB
Configurations

Create a Webhook configuration

Please be aware that using this endpoint requires the Manage Webhooks configurations security role.

post/v7/webhooks/public/api/subscriptions

Request body

endpointstring required

Endpoint for the Webhooks subscription.

namestring required

Display name for the Webhooks configuration.

preArchivedNotificationDaysnumber

Required to have a value of 1 or greater if the "asset_bank.media.pre_archived" event is subscribed to

protocolstring required

Protocol for the Webhooks subscription. Possible values: "http", "https", "email", "email-json", "sqs".

Response

OK

messagestring
successboolean

Example response

{
  "message": "Subscription Config ID cf2493be-c808-41da-bcc2-cfb31f38b457 created",
  "record": {
    "configId": "cf2493be-c808-41da-bcc2-cfb31f38b457",
    "endpoint": "example@example.com",
    "events": [
      "asset_bank.media.archived",
      "asset_bank.media.pre_archived",
      "asset_bank.media.deleted",
      "asset_bank.media.updated",
      "asset_bank.media.meta_updated",
      "asset_bank.media.create",
      "workflow.job.create",
      "antivirus.scan.failed"
    ],
    "is_legacy": false,
    "migratedSubscriptions": "[]",
    "name": "example-webhook-name",
    "portalId": "62dddddd-eeee-ffff-aaaa-9f78fggggggg",
    "preArchivedNotificationDays": 1,
    "protocol": "email",
    "subscriptionArn": "pendingconfirmation",
    "topicArn": "arn:aws:sns:us-east-1:003565342056:62dddddd-eeee-ffff-aaaa-9f78fggggggg-example-webhook-name-cf2493be-c808-41da-bcc2-cfb31f38b457",
    "userId": "DDDDDDE1-DDDD-DDDD-DDDDDD059F8AFFFF"
  },
  "success": true
}