Webhooks – Applydesignapidocs

When making calls using our API, you might want to trigger some operation on your end once it’s complete. This is what webhooks are for.

In order to set up a webhook, go to the Webhooks section in your API page here.

Action Events

image.upload.success

Trigger

Occurs when an image upload was completed successfully. For Auto-staged images, it occurs after the staging result is successfully rendered.

Data body

{
	"Data": {
	  "UniqueId": string,
    "ResultImageUrl": string,
    "ThumbnailUrl": string
  },
  "EventType": "image.upload.success",
  "Timestamp": string
}

image.upload.disposed

Trigger

Occurs when an image you uploaded had been disposed by our systems.

Data body

{
	"Data": {
	  "UniqueId": string,
  },
  "EventType": "image.upload.disposed",
  "Timestamp": string
}

Testing a Webhook

You can test your webhook as part of the development process by registering a webhook in Test mode:

Then click the Test button:

You will then have a chance to fill in your own data, or use the default data, and trigger a call.