Retrieve all webhooks
Get a list of registered webhooks.
GET
Parameters
Query Parameters
Id
Filter resources by their unique identifier
Name
Filter resources by their name or title
Autocomplete
Search term for autocomplete functionality
Limit
How many items to return at one time (max 100)
Next
Pagination token for retrieving the next page of results
Order
Sort order for the results (ascending or descending)
SortBy
Field name to sort the results by
Type
Filter webhooks by their type
Template_id
Filter webhooks by template ID
Action
Filter webhooks by action name
Address
Filter webhooks by blockchain address
Is_active
Filter webhooks by their active status
Wallet_id
Filter webhooks by wallet ID
When_created[$gt]
Filter webhooks created after this date and time
When_created[$lt]
Filter webhooks created before this date and time
When_created[$gte]
Filter webhooks created on or after this date and time
When_created[$lte]
Filter webhooks created on or before this date and time
| Status code | Description |
|---|---|
| 200 | A list of webhooks. |
| 400 | Bad request error - the request contains invalid parameters or malformed data |
| 500 | Internal server error - an unexpected error occurred on the server |
cURL
curl -L \"https://blockv-labs.io/webhooks?id={id}&name={name}&autocomplete={autocomplete}&limit={limit}&next={next}&order={order}&sortBy={sortBy}&type={type}&template_id={template_id}&action={action}&address={address}&is_active={is_active}&wallet_id={wallet_id}&when_created[$gt]={when_created[$gt]}&when_created[$lt]={when_created[$lt]}&when_created[$gte]={when_created[$gte]}&when_created[$lte]={when_created[$lte]}" \-H 'Accept: application/json'
Response
{"webhooks": [{"id": "string","name": "My Webhook","type": "template_activity","wallet_id": "string","url": "https://webhook.site/example","is_active": true,"addresses": ["0x1234567890abcdef1234567890abcdef12345678"],"template_ids": ["tmpl_xxxx123456"],"actions": ["action_xxxx123456"],"when_created": "2021-01-01T00:00:00Z","when_modified": "2021-01-01T00:00:00Z"}],"next": "string"}
json
{"type": "object","required": ["webhooks"],"properties": {"webhooks": {"type": "array","description": "Array of webhook configurations associated with the account or organization.","items": {"type": "object","description": "Represents a webhook configuration.","required": ["id","name","type","url","org_id","wallet_id","signing_key","is_active","when_modified","when_created"],"properties": {"id": {"type": "string","description": "Unique ID for the webhook.","x-oapi-codegen-extra-tags": {"json": "id,omitempty","bson": "_id,omitempty"},"x-go-type": "id.ID","x-go-type-import": {"path": "github.com/vlabsio/smarttoken/pkg/types/id"}},"name": {"type": "string","description": "Descriptive name of the webhook.","example": "My Webhook","x-oapi-codegen-extra-tags": {"bson": "name,omitempty"}},"type": {"type": "string","description": "Enum representing the available webhook types.","enum": ["address_activity","template_activity","action_activity"],"example": "template_activity","x-oapi-codegen-extra-tags": {"bson": "type,omitempty"}},"wallet_id": {"type": "string","description": "Wallet ID that owns the webhook.","x-go-type": "id.ID","x-go-type-import": {"path": "github.com/vlabsio/smarttoken/pkg/types/id"},"x-oapi-codegen-extra-tags": {"bson": "wallet_id,omitempty"}},"url": {"type": "string","format": "uri","description": "URL endpoint where webhook events are sent.","example": "https://webhook.site/example","x-oapi-codegen-extra-tags": {"bson": "url,omitempty"}},"is_active": {"type": "boolean","description": "Whether the webhook is active.","example": true,"x-oapi-codegen-extra-tags": {"bson": "is_active,omitempty"}},"addresses": {"type": "array","description": "List of addresses being tracked, null if not an address activity webhook.","items": {"type": "string","example": "0x1234567890abcdef1234567890abcdef12345678"},"x-oapi-codegen-extra-tags": {"bson": "addresses"},"x-go-type-skip-optional-pointer": true},"template_ids": {"type": "array","description": "List of templates being tracked, null if not a template activity webhook.","items": {"type": "string","example": "tmpl_xxxx123456"},"x-oapi-codegen-extra-tags": {"bson": "template_ids"},"x-go-type-skip-optional-pointer": true},"actions": {"type": "array","description": "List of actions being tracked, null if not an action activity webhook.","items": {"type": "string","example": "action_xxxx123456"},"x-oapi-codegen-extra-tags": {"bson": "actions"},"x-go-type-skip-optional-pointer": true},"when_created": {"type": "string","format": "date-time","description": "When the webhook was created.","example": "2021-01-01T00:00:00Z","x-oapi-codegen-extra-tags": {"bson": "when_created,omitempty"}},"when_modified": {"type": "string","format": "date-time","description": "When the webhook was last modified.","example": "2021-01-01T00:00:00Z","x-oapi-codegen-extra-tags": {"bson": "when_modified,omitempty"}}}}},"next": {"type": "string","description": "Pagination token for retrieving the next set of webhooks.","x-go-type-skip-optional-pointer": true}}}