Metadata

Most updatable Hook0 objects—including Events, Subscriptions, —have a metadata parameter. You can use this parameter to attach arbitrary key-value data to these Hook0 objects.

You can specify up to 50 keys, with key names up to 50 characters long and values up to 50 characters long.

Metadata is useful for storing additional, structured information on an object. For example, you could store your user's corresponding unique identifier from your system on a Hook0 Customer object. By default, metadata isn't used by Hook0—for example, it's not used when forwarding events to subscriptions —but metadata is supported by the Search API. Your users won't see metadata unless you show it to them.

Some of the objects listed above also support a description parameter. You can use the description parameter to annotate a subscription —with, for example, a human-readable description like "Receive new customer events and forward them to Slack channel General". Unlike metadata, description is a single string, and your users may see it (e.g., in subscription max retry alert email Hook0 sends on your behalf).

Don't store any sensitive information (bank account numbers, card details, and so on) in metadata or in the description parameter.