Cakemail Logo
Cakemail API

​Webhook (1.18.25)

Endpoint:https://api.cakemail.dev

​List all webhooks

GET
https://api.cakemail.dev
/webhooks

​List all webhooks › query Parameters

  • with_archivedboolean
  • account_idinteger · min: 1
  • pageinteger · min: 1
    Default: 1
  • per_pageinteger · min: 1
    Default: 50
  • with_countboolean

​List all webhooks › Responses

    • paginationobject · required
    • dataobject[] · required

​Create a webhook

POST
https://api.cakemail.dev
/webhooks

​Create a webhook › query Parameters

  • account_idinteger · min: 1

​Create a webhook › Request Body

  • eventstring · enum · required
    Enum values:
    Account.Created
    Account.Updated
    Account.Confirmed
    Account.Deleted
    Contact.Added
    Contact.Updated
    Contact.Removed
    Contact.Tagged
  • urlstring · uri · minLength: 1 · maxLength: 2083 · required
  • rate_limitinteger
    Default: 50
  • rate_limit_periodstring · enum
    Enum values:
    second
    minute
    Default: second

​Create a webhook › Responses

    • idstring · required
    • dataobject · required

​Archive a webhook

POST
https://api.cakemail.dev
/webhooks/{webhook_id}/archive

​Archive a webhook › path Parameters

  • webhook_idstring · required

​Archive a webhook › query Parameters

  • account_idinteger · min: 1

​Archive a webhook › Responses

    • idstring · required
    • dataobject · required
    • objectstring
      Default: Webhook
    • archivedboolean
      Default: true

​Unarchive a webhook

POST
https://api.cakemail.dev
/webhooks/{webhook_id}/unarchive

​Unarchive a webhook › path Parameters

  • webhook_idstring · required

​Unarchive a webhook › query Parameters

  • account_idinteger · min: 1

​Unarchive a webhook › Responses

    • idstring · required
    • dataobject · required
    • objectstring
      Default: Webhook
    • archivedboolean

​Show a webhook

GET
https://api.cakemail.dev
/webhooks/{webhook_id}

​Show a webhook › path Parameters

  • webhook_idstring · required

​Show a webhook › query Parameters

  • account_idinteger · min: 1

​Show a webhook › Responses

    • idstring · required
    • signatureobject · required
    • dataobject · required

​Patch a webhook

PATCH
https://api.cakemail.dev
/webhooks/{webhook_id}

​Patch a webhook › path Parameters

  • webhook_idstring · required

​Patch a webhook › query Parameters

  • account_idinteger · min: 1

​Patch a webhook › Request Body

  • urlstring · uri · minLength: 1 · maxLength: 2083
  • rate_limitinteger
  • rate_limit_periodstring · enum
    Enum values:
    second
    minute

​Patch a webhook › Responses

    • idstring · required
    • dataobject · required
    • objectstring
      Default: Webhook
    • patchedboolean
      Default: true
System EmailTags