HEhellozai
Webhooks

Create a Webhook

Create a Webhook to notify you at the URL when the object_type changes

post/webhooks

Request

  • Base URL
    https://sandbox.au-0000.api.assemblypay.com
  • URL
    https://sandbox.au-0000.api.assemblypay.com/webhooks
  • Auth
    HTTP bearer

Request body

urlstring required

URL to which the webhook will notify

object_type'batch_transactions' | 'accounts' | 'addresses' | 'companies' | 'items' | 'disbursements' | 'users' | 'transactions' | 'virtual_accounts' | 'pay_ids' | 'verifications' | 'payto_agreements' required

Object or entity to which the webhook refer. Please refer to Webhook for a list of object types.

descriptionstring

Description to identify the webhook

Example request

{
  "url": "https://httpbin.org",
  "object_type": "batch_transactions",
  "description": "Sample Batch Transaction Webhook"
}

Response

Created

uuidstring uuid
object_typestring
http_methodstring
urlstring
descriptionstring
enabledstring
created_atstring date-time
updated_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.