BAbannerbear

Create a webhook

Changed on
post/webhooks

Request

  • Base URL
    https://api.bannerbear.com/v5
  • Auth
    HTTP bearer

Request body

namestring required

Webhook name

urlstring uri required

URL to receive webhook events

resource'image' | 'batch' | 'tool_job' | 'workflow_run' | 'animation'

Resource type to trigger on

event'all_events' | 'completed' | 'failed'

Event type to trigger on

status'active' | 'disabled'

Webhook status

Response

Webhook created. The signing_key field is only returned here — store it now.

uidstring
namestring
urlstring uri
resource'image' | 'batch' | 'tool_job' | 'workflow_run' | 'animation'
event'all_events' | 'completed' | 'failed'
status'active' | 'disabled'
created_atstring date-time
signing_keystring

HMAC signing key. Only returned at creation time — store it now.

Changes

  • 6aa425420a10Revision changes
    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      added the new animation enum value to the response property for the response status

    • warning

      added the new tool_job enum value to the response property for the response status

    • warning

      added the new workflow_run enum value to the response property for the response status

    • info

      added the new animation enum value to the request property

    • info

      added the new tool_job enum value to the request property

    • info

      added the new workflow_run enum value to the request property

    • info

      added the non-success response with the status