URL Expired

The URL for this request expired after 30 days.

webhookId

uuid

required

url

uri

description

string

eventTypes

array of strings

length ≥ 1

eventTypes

Show 13 enum values

string

cardsubscription.created

cardsubscription.updated

transaction.created

transaction.updated

transactionmessage.created

networkbulkfeed.statechanged

enrichment.merchant.created

banklink.completed

bankaccount.state_changed

banktransaction.created

banktransaction.deleted

transaction.match.created

transaction.match.deleted

ADD string

enabled

boolean

truefalse

accept

string

enum

Defaults to application/hal+json

Generated from available response content types

application/hal+json application/problem+json

Allowed:

application/hal+json application/problem+json

`` 200 Successful operation

object

Astrada's Webhook resource.

_links

object

required

self

object

required

self object

id

uuid

required

url

uri

required

description

string | null

required

eventTypes

array of strings

required

length ≥ 1

cardsubscription.created cardsubscription.updated transaction.created transaction.updated transactionmessage.created networkbulkfeed.statechanged enrichment.merchant.created banklink.completed bankaccount.state_changed banktransaction.created banktransaction.deleted transaction.match.created transaction.match.deleted

subaccountId

uuid

required

createdAt

date-time

required

Date and time when this resource was created, in UTC, following ISO 8601 format.

updatedAt

date-time

required

Date and time when this resource was last updated, in UTC, following ISO 8601 format.

enabled

boolean

Defaults to true

`` 400 The server cannot or will not process the request due to something that is perceived to be a client error

`` 401 Authentication credentials were either missing or incorrect

`` 403 Authentication credentials used do not have permissions to perform the request

`` 404 The requested resource was not found on the server

`` 500 The server encountered an unexpected condition that prevented it from fulfilling the request

curl --request PATCH \
     --url https://api.astrada.co/webhooks/webhookId \
     --header 'accept: application/hal+json' \
     --header 'content-type: application/json' \
     --data '\n{\n  "eventTypes": [\\n    "cardsubscription.created"\\n  ]\n}\n'

{
  "_links": {
    "self": {
      "href": "/webhooks/3a45ba7f-8d8f-4f6a-86a5-a17ea0328241"
    }
  },
  "id": "3a45ba7f-8d8f-4f6a-86a5-a17ea0328241",
  "url": "https://example-api.com/path",
  "description": "Example of Webhook description",
  "eventTypes": [\n    "transactionmessage.created"\n  ],
  "subaccountId": "f297d659-c13d-4219-aeaa-e10a845140a5",
  "createdAt": "2023-12-19T14:45:00Z",
  "updatedAt": "2023-12-19T14:45:00Z",
  "enabled": true
}